Responses

• 200 application/json

  The JWT customizers.

  One of:

  object-1 object object-2 object

  Hide attributes Show attributes

  • key string("jwt.accessToken") Required
  • value object Required
    Hide value attributes Show value attributes object

    • script string Required
    • environmentVariables object
      Hide environmentVariables attribute Show environmentVariables attribute object

      • * string Additional properties
    • contextSample object
      Hide contextSample attributes Show contextSample attributes object

      • user object Required
        Hide user attributes Show user attributes object

        • id string

          Minimum length is 1, maximum length is 12.

        • username string | null

          Maximum length is 128.

        • primaryEmail string | null

          Maximum length is 128.

        • primaryPhone string | null

          Maximum length is 128.

        • name string | null

          Maximum length is 128.

        • avatar string | null

          Maximum length is 2048.

        • customData object

          arbitrary

        • identities object
          Hide identities attribute Show identities attribute object

          • * object Additional properties
            Hide * attributes Show * attributes object

            • userId string Required
            • details object

              arbitrary

        • lastSignInAt number | null
        • createdAt number
        • updatedAt number
        • profile object
          Hide profile attributes Show profile attributes object

          • familyName string
          • givenName string
          • middleName string
          • nickname string
          • preferredUsername string
          • profile string
          • website string
          • gender string
          • birthdate string
          • zoneinfo string
          • locale string
          • address object
            Hide address attributes Show address attributes object

            • formatted string
            • streetAddress string
            • locality string
            • region string
            • postalCode string
            • country string
        • applicationId string | null

          Maximum length is 21.

        • isSuspended boolean
        • hasPassword boolean
        • ssoIdentities array[object]
          Hide ssoIdentities attributes Show ssoIdentities attributes object

          • issuer string Required

            Minimum length is 1, maximum length is 256.

          • identityId string Required

            Minimum length is 1, maximum length is 128.

          • detail object Required

            arbitrary

        • mfaVerificationFactors array[string]

          Values are Totp, WebAuthn, BackupCode, EmailVerificationCode, or PhoneVerificationCode.

        • roles array[object]
          Hide roles attributes Show roles attributes object

          • id string Required

            Minimum length is 1, maximum length is 21.

          • name string Required

            Minimum length is 1, maximum length is 128.

          • description string Required

            Minimum length is 1, maximum length is 128.

          • scopes array[object] Required
            Hide scopes attributes Show scopes attributes object

            • id string Required

              Minimum length is 1, maximum length is 21.

            • name string Required

              Minimum length is 1, maximum length is 256.

            • description string | null Required
            • resourceId string Required

              Minimum length is 1, maximum length is 21.

            • resource object Required
              Hide resource attributes Show resource attributes object

              • tenantId string Required

                Maximum length is 21.

              • id string Required

                Minimum length is 1, maximum length is 21.

              • name string Required

                Minimum length is 1.

              • indicator string Required

                Minimum length is 1.

              • isDefault boolean Required
              • accessTokenTtl number Required
        • organizations array[object]
          Hide organizations attributes Show organizations attributes object

          • id string Required

            Minimum length is 1, maximum length is 21.

          • name string Required

            Minimum length is 1, maximum length is 128.

          • description string | null Required

            Maximum length is 256.

        • organizationRoles array[object]
          Hide organizationRoles attributes Show organizationRoles attributes object

          • organizationId string Required
          • roleId string Required
          • roleName string Required
      • grant object
        Hide grant attributes Show grant attributes object

        • type string("urn:ietf:params:oauth:grant-type:token-exchange")
        • subjectTokenContext object

          arbitrary

      • interaction object
        Hide interaction attributes Show interaction attributes object

        • interactionEvent string

          Values are SignIn, Register, or ForgotPassword.

        • userId string
        • verificationRecords array[object]
          One of:

          object-1 object object-2 object object-3 object object-4 object object-5 object object-6 object object-7 object object-8 object object-9 object object-10 object object-11 object

          Hide attributes Show attributes

          • id string Required
          • type string("Password") Required
          • identifier object Required
            Hide identifier attributes Show identifier attributes object

            • type string Required

              One of:

              string-1 string string-2 string

              Values are username, email, or phone.

              Value is userId.

            • value string Required
          • verified boolean Required

          Hide attributes Show attributes

          • id string Required
          • templateType string Required

            Values are SignIn, Register, ForgotPassword, OrganizationInvitation, Generic, UserPermissionValidation, BindNewIdentifier, MfaVerification, or BindMfa.

          • verified boolean Required
          • type string("EmailVerificationCode") Required
          • identifier object Required
            Hide identifier attributes Show identifier attributes object

            • type string("email") Required
            • value string Required

          Hide attributes Show attributes

          • id string Required
          • templateType string Required

            Values are SignIn, Register, ForgotPassword, OrganizationInvitation, Generic, UserPermissionValidation, BindNewIdentifier, MfaVerification, or BindMfa.

          • verified boolean Required
          • type string("PhoneVerificationCode") Required
          • identifier object Required
            Hide identifier attributes Show identifier attributes object

            • type string("phone") Required
            • value string Required

          Hide attributes Show attributes

          • id string Required
          • connectorId string Required
          • type string("Social") Required
          • socialUserInfo object
            Hide socialUserInfo attributes Show socialUserInfo attributes object

            • id string Required
            • email string
            • phone string
            • name string
            • avatar string

            • rawData object | null | array[string | number | boolean | null | object] | string | number | boolean

              One of:

              object-1 object | null array-2 array[string | number | boolean | null | object] | null string-3 string | null number-4 number | null boolean-5 boolean | null

              arbitrary JSON object

              One of:

              string-1 string number-2 number boolean-3 boolean string-4 string | null object-5 object

              null value

              arbitrary JSON object

          Hide attributes Show attributes

          • id string Required
          • connectorId string Required
          • type string("EnterpriseSso") Required
          • enterpriseSsoUserInfo object
            Hide enterpriseSsoUserInfo attributes Show enterpriseSsoUserInfo attributes object

            • id string Required
            • email string
            • phone string
            • name string
            • avatar string

            • rawData object | null | array[string | number | boolean | null | object] | string | number | boolean

              One of:

              object-1 object | null array-2 array[string | number | boolean | null | object] | null string-3 string | null number-4 number | null boolean-5 boolean | null

              arbitrary JSON object

              One of:

              string-1 string number-2 number boolean-3 boolean string-4 string | null object-5 object

              null value

              arbitrary JSON object
          • issuer string

          Hide attributes Show attributes

          • id string Required
          • type string("Totp") Required
          • userId string Required
          • verified boolean Required

          Hide attributes Show attributes

          • id string Required
          • type string("BackupCode") Required
          • userId string Required
          • code string

          Hide attributes Show attributes

          • id string Required
          • verified boolean Required
          • registrationRpId string
          • type string("WebAuthn") Required
          • userId string Required

          Hide attributes Show attributes

          • id string Required
          • verified boolean Required
          • registrationRpId string
          • type string("SignInWebAuthn") Required
          • userId string

          Hide attributes Show attributes

          • id string Required
          • type string("OneTimeToken") Required
          • verified boolean Required
          • identifier object Required
            Hide identifier attributes Show identifier attributes object

            • type string("email") Required
            • value string Required
          • oneTimeTokenContext object
            Hide oneTimeTokenContext attribute Show oneTimeTokenContext attribute object

            • jitOrganizationIds array[string]

          Hide attributes Show attributes

          • id string Required
          • type string("NewPasswordIdentity") Required
          • identifier object Required
            Hide identifier attributes Show identifier attributes object

            • type string Required

              Values are username, email, or phone.

            • value string Required
        • signInContext object
          Hide signInContext attribute Show signInContext attribute object

          • * string Additional properties
      • application object
        Hide application attributes Show application attributes object

        • tenantId string

          Maximum length is 21.

        • id string

          Minimum length is 1, maximum length is 21.

        • name string

          Minimum length is 1, maximum length is 256.

        • description string | null
        • type string

          Values are Native, SPA, Traditional, MachineToMachine, Protected, or SAML.

        • oidcClientMetadata object
          Hide oidcClientMetadata attributes Show oidcClientMetadata attributes object

          • redirectUris array[object] Required

            Validator function

            Validator function

          • postLogoutRedirectUris array[object] Required

            Validator function

            Validator function

          • backchannelLogoutUri string(url)
          • backchannelLogoutSessionRequired boolean
          • logoUri string
        • customClientMetadata object
          Hide customClientMetadata attributes Show customClientMetadata attributes object

          • corsAllowedOrigins array[string]

            Minimum length of each is 1.

          • idTokenTtl number
          • refreshTokenTtl number
          • refreshTokenTtlInDays number
          • tenantId string
          • alwaysIssueRefreshToken boolean
          • rotateRefreshToken boolean
          • allowTokenExchange boolean
        • protectedAppMetadata object | null
          Hide protectedAppMetadata attributes Show protectedAppMetadata attributes object | null

          • host string Required
          • origin string Required
          • sessionDuration number Required
          • pageRules array[object] Required
            Hide pageRules attribute Show pageRules attribute object

            • path string Required
          • customDomains array[object]
            Hide customDomains attributes Show customDomains attributes object

            • domain string Required
            • status string Required

              Values are PendingVerification, PendingSsl, Active, or Error.

            • errorMessage string | null Required
            • dnsRecords array[object] Required
              Hide dnsRecords attributes Show dnsRecords attributes object

              • name string Required
              • type string Required
              • value string Required
            • cloudflareData object | null Required
              Hide cloudflareData attributes Show cloudflareData attributes object | null

              • id string Required
              • status string Required
              • ssl object Required
                Hide ssl attributes Show ssl attributes object

                • status string Required
                • validation_errors array[object]
                  Hide validation_errors attribute Show validation_errors attribute object

                  • message string Required
              • verification_errors array[string]
        • customData object

          arbitrary

        • isThirdParty boolean
        • createdAt number
    • tokenSample object
      Hide tokenSample attributes Show tokenSample attributes object

      • jti string

      • aud string | array[string]

        One of:

        string-1 string array-2 array[string]
      • scope string
      • clientId string
      • accountId string
      • expiresWithSession boolean
      • grantId string
      • gty string
      • sessionUid string
      • sid string
      • kind string("AccessToken")

  Hide attributes Show attributes

  • key string("jwt.clientCredentials") Required
  • value object Required
    Hide value attributes Show value attributes object

    • script string Required
    • environmentVariables object
      Hide environmentVariables attribute Show environmentVariables attribute object

      • * string Additional properties
    • contextSample object
      Hide contextSample attribute Show contextSample attribute object

      • application object
        Hide application attributes Show application attributes object

        • tenantId string

          Maximum length is 21.

        • id string

          Minimum length is 1, maximum length is 21.

        • name string

          Minimum length is 1, maximum length is 256.

        • description string | null
        • type string

          Values are Native, SPA, Traditional, MachineToMachine, Protected, or SAML.

        • oidcClientMetadata object
          Hide oidcClientMetadata attributes Show oidcClientMetadata attributes object

          • redirectUris array[object] Required

            Validator function

            Validator function

          • postLogoutRedirectUris array[object] Required

            Validator function

            Validator function

          • backchannelLogoutUri string(url)
          • backchannelLogoutSessionRequired boolean
          • logoUri string
        • customClientMetadata object
          Hide customClientMetadata attributes Show customClientMetadata attributes object

          • corsAllowedOrigins array[string]

            Minimum length of each is 1.

          • idTokenTtl number
          • refreshTokenTtl number
          • refreshTokenTtlInDays number
          • tenantId string
          • alwaysIssueRefreshToken boolean
          • rotateRefreshToken boolean
          • allowTokenExchange boolean
        • protectedAppMetadata object | null
          Hide protectedAppMetadata attributes Show protectedAppMetadata attributes object | null

          • host string Required
          • origin string Required
          • sessionDuration number Required
          • pageRules array[object] Required
            Hide pageRules attribute Show pageRules attribute object

            • path string Required
          • customDomains array[object]
            Hide customDomains attributes Show customDomains attributes object

            • domain string Required
            • status string Required

              Values are PendingVerification, PendingSsl, Active, or Error.

            • errorMessage string | null Required
            • dnsRecords array[object] Required
              Hide dnsRecords attributes Show dnsRecords attributes object

              • name string Required
              • type string Required
              • value string Required
            • cloudflareData object | null Required
              Hide cloudflareData attributes Show cloudflareData attributes object | null

              • id string Required
              • status string Required
              • ssl object Required
                Hide ssl attributes Show ssl attributes object

                • status string Required
                • validation_errors array[object]
                  Hide validation_errors attribute Show validation_errors attribute object

                  • message string Required
              • verification_errors array[string]
        • customData object

          arbitrary

        • isThirdParty boolean
        • createdAt number
    • tokenSample object
      Hide tokenSample attributes Show tokenSample attributes object

      • jti string

      • aud string | array[string]

        One of:

        string-1 string array-2 array[string]
      • scope string
      • clientId string
      • kind string("ClientCredentials")
• 401

  Unauthorized

• 403

  Forbidden