Update a client
Updates a client’s settings. For more information, read Applications in Auth0 and Single Sign-On.
Notes:
- The
client_secretandsigning_keyattributes can only be updated with theupdate:client_keysscope. - The
client_authentication_methodsandtoken_endpoint_auth_methodproperties are mutually exclusive. Useclient_authentication_methodsto configure the client with Private Key JWT authentication method. Otherwise, usetoken_endpoint_auth_methodto configure the client with client secret (basic or post) or with no authentication method (none). - When using
client_authentication_methodsto configure the client with Private Key JWT authentication method, only specify the credential IDs that were generated when creating the credentials on the client. - To configure
client_authentication_methods, theupdate:client_credentialsscope is required. - To configure
client_authentication_methods, the propertyjwt_configuration.algmust be set to RS256. - To change a client’s
is_first_partyproperty tofalse, theorganization_usageandorganization_require_behaviorproperties must be unset.
Authorizations
Scopes
Body
A set of grant types that the client is authorized to use. 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, urn:openid:params:grant-type:ciba, urn:ietf:params:oauth:grant-type:device_code, and urn:auth0:params:oauth:grant-type:token-exchange:federated-connection-access-token.
1Defines 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).
none, client_secret_post, client_secret_basic, null The type of application this client represents
native, spa, regular_web, non_interactive, resource_server, express_configuration, rms, box, cloudbees, concur, dropbox, mscrm, echosign, egnyte, newrelic, office365, salesforce, sentry, sharepoint, slack, springcm, zendesk, zoom, sso_integration, oag 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.
no_prompt, pre_login_prompt, post_login_prompt, null Defines the available methods for organization discovery during the pre_login_prompt. Users can discover their organization either by email, organization_name or both.
1Method for discovering organizations during the pre_login_prompt. email allows users to find their organization by entering their email address and performing domain matching, while organization_name requires users to enter the organization name directly. These methods can be combined.
email, organization_name Controls whether a confirmation prompt is shown during login flows when the redirect URI uses non-verifiable callback URIs (for example, a custom URI schema such as myapp://, or localhost).
If set to true, a confirmation prompt will not be shown. We recommend that this is set to false for improved protection from malicious apps.
See https://auth0.com/docs/secure/security-guidance/measures-against-app-impersonation for more information.
Security mode for third-party clients. strict enforces enhanced security controls: OAuth 2.1 alignment, explicit API authorization, and a curated set of supported features. permissive preserves pre-existing behavior and is only available to tenants with prior third-party client usage. Set on creation and cannot be modified.
strict, permissive Controls whether Auth0 redirects users to the application's callback URL on authentication errors or in email verification flows. open_redirect_protection shows an error page instead of redirecting, and hides the callback domain from email templates. allow_always enables standard redirect behavior. Defaults to open_redirect_protection for third-party clients. Only applies when is_first_party is false and third_party_security_mode is strict. To learn more, read Redirect protection.
allow_always, open_redirect_protection Response
Client successfully updated.
The type of application this client represents
native, spa, regular_web, non_interactive, resource_server, express_configuration, rms, box, cloudbees, concur, dropbox, mscrm, echosign, egnyte, newrelic, office365, salesforce, sentry, sharepoint, slack, springcm, zendesk, zoom, sso_integration, oag Whether this client conforms to strict OIDC specifications (true) or uses legacy features (false).
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.
Comma-separated list of allowed origins for use with Cross-Origin Authentication, Device Flow, and web message response mode.
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, urn:openid:params:grant-type:ciba, urn:ietf:params:oauth:grant-type:device_code, and urn:auth0:params:oauth:grant-type:token-exchange:federated-connection-access-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).
none, client_secret_post, client_secret_basic 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.
no_prompt, pre_login_prompt, post_login_prompt Defines the available methods for organization discovery during the pre_login_prompt. Users can discover their organization either by email, organization_name or both.
1Method for discovering organizations during the pre_login_prompt. email allows users to find their organization by entering their email address and performing domain matching, while organization_name requires users to enter the organization name directly. These methods can be combined.
email, organization_name Controls whether a confirmation prompt is shown during login flows when the redirect URI uses non-verifiable callback URIs (for example, a custom URI schema such as myapp://, or localhost).
If set to true, a confirmation prompt will not be shown. We recommend that this is set to false for improved protection from malicious apps.
See https://auth0.com/docs/secure/security-guidance/measures-against-app-impersonation for more information.
Security mode for third-party clients. strict enforces enhanced security controls: OAuth 2.1 alignment, explicit API authorization, and a curated set of supported features. permissive preserves pre-existing behavior and is only available to tenants with prior third-party client usage. Set on creation and cannot be modified.
strict, permissive Controls whether Auth0 redirects users to the application's callback URL on authentication errors or in email verification flows. open_redirect_protection shows an error page instead of redirecting, and hides the callback domain from email templates. allow_always enables standard redirect behavior. Defaults to open_redirect_protection for third-party clients. Only applies when is_first_party is false and third_party_security_mode is strict. To learn more, read Redirect protection.
allow_always, open_redirect_protection Indicates the type of external metadata used to register the client. This field is omitted for regular clients. The value cimd identifies clients registered via a Client ID Metadata Document. The value dcr identifies clients registered via Dynamic Client Registration.
cimd, dcr Indicates who created the external metadata client. The value admin indicates the client was registered via the Management API. The value client indicates the client was registered dynamically. This field is only present when external_metadata_type is set.
admin, client