Skip to main content

createClient

ClientResponse createClient(CreateClientRequest)

POST /api/2.0/oauth2/clients

Create a new OAuth2 client

Registers a new OAuth2 client in the caller's tenant and returns it. The body must carry a name, a description, a logo and at least one redirect URI, allowed origin and scope, and every scope named must already exist in the tenant's scope catalogue. Administrators and users may both register clients; the caller is recorded as the creator, which is what later restricts a plain user to the clients they created. The response is the stored client with its generated client ID and secret, and it is the first place either value can be read. Some deployments cap how many clients one tenant may hold, and reaching that cap is reported as 400 together with the validation failures.

Parameters​

NameInTypeDescriptionNotes
CreateClientRequestbodyCreateClientRequest[required]

Responses​

Status codeDescriptionTypeResponse headers
201Client successfully createdClientResponse-
400Missing required fields, validation failed, an unknown scope was requested, or the client limit for this tenant has been reachedProblemDetail-
403Insufficient permissions to create clientProblemDetail-
415The Content-Type header is not application/jsonProblemDetail-
429Too many requests - rate limit exceededProblemDetail-
500Internal server error occurredProblemDetail-
405The HTTP method is not allowed for this pathProblemDetail-
406The Accept header does not allow application/jsonProblemDetail-

Return type​

ClientResponse

Authorization​

x-signature

HTTP request headers​

  • Content-Type: application/json
  • Accept: application/json