Appearance
POST
/developer/clientsRequired scope:
apiclient:createCreates an API client. The response contains the client secret — the only time it is shown.
Request body
JSON
{
"name": "...",
"scopes": [
"..."
]
}
Response
The created client, including its secret.
JSON
{
"clientId": "...",
"clientSecret": "...",
"name": "...",
"scopes": [
"..."
],
"expiresAt": "2024-08-14T12:34:56.412"
}
| Error code | Description |
|---|---|
auth.api-client.global-scope-not-allowed | Global scopes cannot be granted to external API clients. |
auth.api-client.internal-scope-not-allowed | Internal-only scopes cannot be granted to external API clients. |
auth.api-client.management-scope-not-allowed | API client management scopes cannot be granted to external API clients. |
auth.api-client.name-required | The API client must have a name. |
auth.api-client.name-taken | An API client with this name already exists. |
auth.api-client.role-required | A signed-in user must hold the apiclient role. |
auth.api-client.scope-not-allowed-for-app | One of the given scopes is cross-tenant, which the app cannot hold. |
auth.api-client.unknown-scope | One of the given scopes does not exist. |