Optional
addonsOptional
allowed_Optional
allowed_Comma-separated list of URLs that are valid to redirect to after logout from Auth0. Wildcards are allowed for subdomains.
Optional
allowed_Comma-separated list of URLs allowed to make requests from JavaScript to Auth0 API (typically used with CORS). By default, all your callback URLs will be allowed. This field allows you to enter other origins if necessary. You can also use wildcards at the subdomain level (e.g., https://*.contoso.com). Query strings and hash information are not taken into account when validating these URLs.
Optional
app_Type of client used to determine which settings are applicable. Can be spa
, native
, non_interactive
, or regular_web
.
Optional
callbacksComma-separated list of URLs whitelisted for Auth0 to use as a callback to the client after authentication.
Optional
client_List of audiences/realms for SAML protocol. Used by the wsfed addon.
Optional
client_Optional
client_Metadata associated with the client, in the form of an object with string values (max 255 chars). Maximum of 10 metadata properties allowed. Field names (max 255 chars) are alphanumeric and may only include the following special characters: :,-+=_*?"/()<>@ [Tab] [Space]
Optional
compliance_Defines the compliance level for this client, which may restrict it's capabilities
Optional
cross_Whether this client can be used to make cross-origin authentication requests (true) or it is not allowed to make such requests (false).
Optional
cross_URL of the location in your site where the cross origin verification takes place for the cross-origin auth flow when performing Auth in your own domain instead of Auth0 hosted login page.
Optional
custom_The content (HTML, CSS, JS) of the custom login page.
Optional
custom_true
if the custom login page is to be used, false
otherwise. Defaults to true
Optional
custom_The content (HTML, CSS, JS) of the custom login page. (Used on Previews)
Optional
descriptionFree text description of this client (max length: 140 characters).
Optional
encryption_Optional
form_HTML form template to be used for WS-Federation.
Optional
grant_List of grant types supported for this application. Can include authorization_code
, implicit
, refresh_token
, client_credentials
, password
, http://auth0.com/oauth/grant-type/password-realm
, http://auth0.com/oauth/grant-type/mfa-oob
, http://auth0.com/oauth/grant-type/mfa-otp
, http://auth0.com/oauth/grant-type/mfa-recovery-code
, and urn:ietf:params:oauth:grant-type:device_code
.
Optional
initiate_Initiate login uri, must be https
Optional
is_Whether this client a first party client or not
Optional
jwt_Optional
logo_URL of the logo to display for this client. Recommended size is 150x150 pixels.
Optional
mobileName of this client (min length: 1 character, does not allow <
or >
).
Optional
native_Optional
oidc_Whether this client conforms to strict OIDC specifications (true) or uses legacy features (false).
Optional
oidc_Optional
organization_Defines how to proceed during an authentication transaction when client.organization_usage: 'require'
. Can be no_prompt
(default), pre_login_prompt
or post_login_prompt
. post_login_prompt
requires oidc_conformant: true
.
Optional
organization_Defines how to proceed during an authentication transaction with regards an organization. Can be deny
(default), allow
or require
.
Optional
refresh_Optional
require_Makes the use of Proof-of-Possession mandatory for this client
Optional
require_Makes the use of Pushed Authorization Requests mandatory for this client
Optional
signed_Optional
ssoApplies only to SSO clients and determines whether Auth0 will handle Single Sign On (true) or whether the Identity Provider will (false).
Optional
sso_true
to disable Single Sign On, false
otherwise (default: false
)
Optional
token_Defines the requested authentication method for the token endpoint. Can be none
(public client without a client secret), client_secret_post
(client uses HTTP POST parameters), or client_secret_basic
(client uses HTTP Basic).
Optional
web_Comma-separated list of allowed origins for use with Cross-Origin Authentication, Device Flow, and web message response mode.
List of allow clients and API ids that are allowed to make delegation requests. Empty means all all your clients are allowed.