Important: To enable credentials to be used for a client authentication method, set the client_authentication_methods property on the client. To enable credentials to be used for JWT-Secured Authorization requests set the signed_request_object property on the client.\n"
},
{
"info": {
"name": "Create a Client Credential",
"type": "http"
},
"http": {
"method": "POST",
"url": "{auth0_domain}/clients/:client_id/credentials",
"params": [
{
"name": "client_id",
"value": "",
"type": "path",
"description": "ID of the client."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Create a client credential associated to your application. Credentials can be used to configure Private Key JWT and mTLS authentication methods, as well as for JWT-secured Authorization requests.\n\nPublic Key
Public Key credentials can be used to set up Private Key JWT client authentication and JWT-secured Authorization requests.\n\nSample: {\n \"credential_type\": \"public_key\",\n \"name\": \"string\",\n \"pem\": \"string\",\n \"alg\": \"RS256\",\n \"parse_expiry_from_cert\": false,\n \"expires_a"
},
{
"info": {
"name": "Get Client Credential Details",
"type": "http"
},
"http": {
"method": "GET",
"url": "{auth0_domain}/clients/:client_id/credentials/:credential_id",
"params": [
{
"name": "client_id",
"value": "",
"type": "path",
"description": "ID of the client."
},
{
"name": "credential_id",
"value": "",
"type": "path",
"description": "ID of the credential."
}
]
},
"docs": "Get the details of a client credential.\n\nImportant: To enable credentials to be used for a client authentication method, set the client_authentication_methods property on the client. To enable credentials to be used for JWT-Secured Authorization requests set the signed_request_object property on the client.\n"
},
{
"info": {
"name": "Update a Client Credential",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "{auth0_domain}/clients/:client_id/credentials/:credential_id",
"params": [
{
"name": "client_id",
"value": "",
"type": "path",
"description": "ID of the client."
},
{
"name": "credential_id",
"value": "",
"type": "path",
"description": "ID of the credential."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Change a client credential you previously created. May be enabled or disabled. For more information, read Client Credential Flow."
},
{
"info": {
"name": "Delete a Client Credential",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "{auth0_domain}/clients/:client_id/credentials/:credential_id",
"params": [
{
"name": "client_id",
"value": "",
"type": "path",
"description": "ID of the client."
},
{
"name": "credential_id",
"value": "",
"type": "path",
"description": "ID of the credential to delete."
}
]
},
"docs": "Delete a client credential you previously created. May be enabled or disabled. For more information, read Client Credential Flow."
},
{
"info": {
"name": "Get Client by ID",
"type": "http"
},
"http": {
"method": "GET",
"url": "{auth0_domain}/clients/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "ID of the client to retrieve."
},
{
"name": "fields",
"value": "",
"type": "query",
"description": "Comma-separated list of fields to include or exclude (based on value provided for include_fields) in the result. Leave empty to retrieve all fields."
},
{
"name": "include_fields",
"value": "",
"type": "query",
"description": "Whether specified fields are to be included (true) or excluded (false)."
}
]
},
"docs": "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. \nFor more information, read Applications in Auth0 and Single Sign-On.\n\n - \n The following properties can be retrieved with any of the scopes:\n
client_id, app_type<"
},
{
"info": {
"name": "Update a Client",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "{auth0_domain}/clients/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "ID of the client to update."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Updates a client's settings. For more information, read Applications in Auth0 and Single Sign-On.\n\nNotes:\n- The `client_secret` and `signing_key` attributes can only be updated with the `update:client_keys` scope.\n- The client_authentication_methods and token_endpoint_auth_method properties are mutually exclusive. Use client_auth"
},
{
"info": {
"name": "Delete a Client",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "{auth0_domain}/clients/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "ID of the client to delete."
}
]
},
"docs": "Delete a client and related configuration (rules, connections, etc)."
},
{
"info": {
"name": "Get Enabled Connections for a Client",
"type": "http"
},
"http": {
"method": "GET",
"url": "{auth0_domain}/clients/:id/connections",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "ID of the client for which to retrieve enabled connections."
},
{
"name": "strategy",
"value": "",
"type": "query",
"description": "Provide strategies to only retrieve connections with such strategies"
},
{
"name": "from",
"value": "",
"type": "query",
"description": "Optional Id from which to start selection."
},
{
"name": "take",
"value": "",
"type": "query",
"description": "Number of results per page. Defaults to 50."
},
{
"name": "fields",
"value": "",
"type": "query",
"description": "A comma separated list of fields to include or exclude (depending on include_fields) from the result, empty to retrieve all fields"
},
{
"name": "include_fields",
"value": "",
"type": "query",
"description": "true if the fields specified are to be included in the result, false otherwise (defaults to true)"
}
]
},
"docs": "Retrieve all connections that are enabled for the specified Application, using checkpoint pagination. A list of fields to include or exclude for each connection may also be specified.\n\n - \n This endpoint requires the
read:connections scope and any one of read:clients or read:client_summary.\n \n - \n Note: The first time you call this endpoint, omit the
fromRotate Client Secrets."
}
]
}
],
"bundled": true
}