Download OpenAPI specification:Download
Allows an application to manage its clients, including updating existing clients and creating additional clients. To authorize API calls, use an access token for the relevant application. To manage apps and their clients as a tenant admin, see Application APIs.
Creates an additional client for the app. To authorize a request, use an access token for the relevant application.
| name required | string Name of the client |
| description | string Short description of the client |
| redirect_uris required | Array of strings List of URIs approved for redirects for your client |
| client_type | string Default: "web" Client type |
| response_types | Array of strings Default: ["code","id_token"] Items Enum: "code" "id_token" |
| token_endpoint_auth_method | string Default: "client_secret_basic" Which token endpoint authentication method to allow for the token endpoint. Unauthorized requests are only allowed for native clients that will perform a centralized login flow (via the Authentication Hub) with PKCE. |
| resources | Array of strings List of resources IDs associated with this client |
object Configuration for an OAuth Device Authorization Flow | |
object CIBA authorization flow configuration |
{- "name": "My Client",
- "description": "string",
- "client_type": "web",
- "response_types": [
- "code"
], - "token_endpoint_auth_method": "client_secret_basic",
- "resources": [
- "string"
], - "device_authorization": {
- "enabled": false,
},
}{- "result": {
- "app_id": "string",
- "tenant_id": "string",
- "client_id": "string",
- "client_secret": "string",
- "name": "string",
- "description": "string",
- "redirect_uris": [
- "string"
], - "client_type": "web",
- "response_types": [
- "code"
], - "token_endpoint_auth_method": "client_secret_basic",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "resources": [
- "string"
], - "device_authorization": {
- "enabled": false,
},
}
}Retrieves a list of clients for the app. To authorize a request, use an access token for the relevant application.
{- "result": [
- {
- "app_id": "string",
- "tenant_id": "string",
- "client_id": "string",
- "client_secret": "string",
- "name": "string",
- "description": "string",
- "redirect_uris": [
- "string"
], - "client_type": "web",
- "response_types": [
- "code"
], - "token_endpoint_auth_method": "client_secret_basic",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "resources": [
- "string"
], - "device_authorization": {
- "enabled": false,
},
}
]
}Deletes all clients associated with the app. To authorize a request, use an access token for the relevant application. Note that the application cannot be used without clients.
{- "message": "Bad request",
- "error_code": 400
}Retrieves a client by client ID. To authorize a request, use an access token for the relevant application.
{- "result": {
- "app_id": "string",
- "tenant_id": "string",
- "client_id": "string",
- "client_secret": "string",
- "name": "string",
- "description": "string",
- "redirect_uris": [
- "string"
], - "client_type": "web",
- "response_types": [
- "code"
], - "token_endpoint_auth_method": "client_secret_basic",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "resources": [
- "string"
], - "device_authorization": {
- "enabled": false,
},
}
}Update a client by its ID. To authorize a request, use an access token for the relevant application. Note: Fields that are objects cannot be partially updated, since the new value you set will just replace the current one.
| name | string Name of the client |
| description | string Short description of the client |
| redirect_uris | Array of strings List of URIs approved for redirects for your client |
| client_type | string Default: "web" Client type |
| response_types | Array of strings Default: ["code","id_token"] Items Enum: "code" "id_token" |
| token_endpoint_auth_method | string Default: "client_secret_basic" Which token endpoint authentication method to allow for the token endpoint. Unauthorized requests are only allowed for native clients that will perform a centralized login flow (via the Authentication Hub) with PKCE. |
| resources | Array of strings List of resources IDs associated with this client |
object Configuration for an OAuth Device Authorization Flow | |
object CIBA authorization flow configuration |
{- "name": "My Client",
- "description": "string",
- "client_type": "web",
- "response_types": [
- "code"
], - "token_endpoint_auth_method": "client_secret_basic",
- "resources": [
- "string"
], - "device_authorization": {
- "enabled": false,
},
}{- "result": {
- "app_id": "string",
- "tenant_id": "string",
- "client_id": "string",
- "client_secret": "string",
- "name": "string",
- "description": "string",
- "redirect_uris": [
- "string"
], - "client_type": "web",
- "response_types": [
- "code"
], - "token_endpoint_auth_method": "client_secret_basic",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "resources": [
- "string"
], - "device_authorization": {
- "enabled": false,
},
}
}Deletes a client. To authorize a request, use an access token for the relevant application.
{- "message": "Bad request",
- "error_code": 400
}Updates the list of resources that a client is allowed to explicitly request access to. To authorize a request, use an access token for the relevant application.
{- "resource_ids": [
- "string"
]
}{- "result": {
- "app_id": "string",
- "tenant_id": "string",
- "client_id": "string",
- "client_secret": "string",
- "name": "string",
- "description": "string",
- "redirect_uris": [
- "string"
], - "client_type": "web",
- "response_types": [
- "code"
], - "token_endpoint_auth_method": "client_secret_basic",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "resources": [
- "string"
], - "device_authorization": {
- "enabled": false,
},
}
}