Clients
clients
Methods
Create a new client (application or SSO integration). For more information, read Create Applications API Endpoints for Single Sign-On.
Notes:
- We recommend leaving the
client_secretparameter unspecified to allow the generation of a safe secret. - 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, specify fully defined credentials. These credentials will be automatically enabled for Private Key JWT authentication on the client. - To configure
client_authentication_methods, thecreate:client_credentialsscope is required. - To configure
client_authentication_methods, the propertyjwt_configuration.algmust be set to RS256.
Delete a client and related configuration (rules, connections, etc).
Retrieve clients (applications and SSO integrations) matching provided filters. A list of fields to include or exclude may also be specified. For more information, read Applications in Auth0 and Single Sign-On.
-
The following can be retrieved with any scope:
client_id,app_type,name, anddescription. -
The following properties can only be retrieved with the
read:clientsorread:client_keysscope:callbacks,oidc_logout,allowed_origins,web_origins,tenant,global,config_route,callback_url_template,jwt_configuration,jwt_configuration.lifetime_in_seconds,jwt_configuration.secret_encoded,jwt_configuration.scopes,jwt_configuration.alg,api_type,logo_uri,allowed_clients,owners,custom_login_page,custom_login_page_off,sso,addons,form_template,custom_login_page_codeview,resource_servers,client_metadata,mobile,mobile.android,mobile.ios,allowed_logout_urls,token_endpoint_auth_method,is_first_party,oidc_conformant,is_token_endpoint_ip_header_trusted,initiate_login_uri,grant_types,refresh_token,refresh_token.rotation_type,refresh_token.expiration_type,refresh_token.leeway,refresh_token.token_lifetime,organization_usage,organization_require_behavior. -
The following properties can only be retrieved with the
read:client_keysorread:client_credentialsscope:encryption_key,encryption_key.pub,encryption_key.cert,client_secret,client_authentication_methodsandsigning_key.
Retrieve client details by ID. Clients are SSO connections or Applications linked with your Auth0 tenant. A list of fields to include or exclude may also be specified. For more information, read Applications in Auth0 and Single Sign-On.
-
The following properties can be retrieved with any of the scopes:
client_id,app_type,name, anddescription. -
The following properties can only be retrieved with the
read:clientsorread:client_keysscopes:callbacks,oidc_logout,allowed_origins,web_origins,tenant,global,config_route,callback_url_template,jwt_configuration,jwt_configuration.lifetime_in_seconds,jwt_configuration.secret_encoded,jwt_configuration.scopes,jwt_configuration.alg,api_type,logo_uri,allowed_clients,owners,custom_login_page,custom_login_page_off,sso,addons,form_template,custom_login_page_codeview,resource_servers,client_metadata,mobile,mobile.android,mobile.ios,allowed_logout_urls,token_endpoint_auth_method,is_first_party,oidc_conformant,is_token_endpoint_ip_header_trusted,initiate_login_uri,grant_types,refresh_token,refresh_token.rotation_type,refresh_token.expiration_type,refresh_token.leeway,refresh_token.token_lifetime,organization_usage,organization_require_behavior. -
The following properties can only be retrieved with the
read:client_keysorread:client_credentialsscopes:encryption_key,encryption_key.pub,encryption_key.cert,client_secret,client_authentication_methodsandsigning_key.
Rotate a client secret.
This endpoint cannot be used with clients configured with Private Key JWT authentication method (client_authentication_methods configured with private_key_jwt).
Note: The generated secret is NOT base64 encoded.
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.
Credentials
clients.credentials
Methods
Create a client credential associated to your application. The credential will be created but not yet enabled for use with Private Key JWT authentication method. To enable the credential, set the client_authentication_methods property on the client.
For more information, read Configure Private Key JWT Authentication.
Delete a client credential you previously created. May be enabled or disabled. For more information, read Client Credential Flow.
Get the details of a client credential.
Important: To enable credentials to be used for Private Key JWT authentication method, set the client_authentication_methods property on the client.
Get the details of a client credential.
Important: To enable credentials to be used for Private Key JWT authentication method, set the client_authentication_methods property on the client.
Change a client credential you previously created. May be enabled or disabled. For more information, read Client Credential Flow.
Domain types