Skip to main content

getClient

ClientResponse getClient(clientId)

GET /api/2.0/oauth2/clients/{clientId}

Get client details

Returns the whole stored record of one client: its name and description, its secret, scopes, redirect URIs, allowed origins, logout redirect URIs and audit fields. An administrator sees any client of the tenant, a plain user only the clients they created, and a guest none of them. Whatever the caller may not see is reported as 404 rather than 403, so absence and lack of access are deliberately indistinguishable, and an identifier that is not a valid client ID is reported the same way. The response is a single object, not a collection.

Parameters​

NameInTypeDescriptionNotes
clientIdpathStringID of the client to retrieve[required] [example: 6c7cf17b-1bd3-47d5-94c6-be2d3570e168] [minLength: 1]

Responses​

Status codeDescriptionTypeResponse headers
200Client details successfully retrievedClientResponse-
400The client ID is blank or contains only whitespaceProblemDetail-
403Insufficient permissions to view clientProblemDetail-
404No client with this ID is visible to the caller, or the ID cannot be parsed as a client IDProblemDetail-
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: Not defined
  • Accept: application/json