Retrieve a list of OAuth2 clients
Retrieve a list of existing OAuth 2.0 clients for your organization.
Header Parameters
- SlashID-OrgID string required
The organization ID
Example: af5fbd30-7ce7-4548-8b30-4cd59cb2aba1
Responses
- 200
- 400
OK
- application/json
- Schema
- Example (from schema)
Schema
meta object
pagination object
limit integeroffset integertotal_count int64errors object[]
httpcode integermessage stringresult object[]
client_id stringThe client identifier.
client_name stringHuman-friendly name to identify this client.
grant_types string[]Possible values: [
client_credentials]The client's allowed grant types.
response_types array[]Possible values: [
code,id_token,token]The client's allowed response types. All allowed combinations of response types have to be listed.
scopes string[]The scopes this client is allowed to request.
access_token_duration integerHow long (in seconds) access tokens should be valid for. If unspecified, it is set to your organization's default value.
public booleanIndicates if this client is marked as public. Public clients are unable to use registered client secrets, such as applications running in a browser or on a mobile device.
{
"meta": {
"pagination": {
"limit": 0,
"offset": 0,
"total_count": 0
}
},
"errors": [
{
"httpcode": 0,
"message": "string"
}
],
"result": [
{
"client_id": "string",
"client_name": "string",
"grant_types": [
"client_credentials"
],
"response_types": [
[
"code"
]
],
"scopes": [
"string"
],
"access_token_duration": 0,
"public": true
}
]
}
Bad Request
- application/json
- Schema
- Example (from schema)
Schema
meta object
pagination object
limit integeroffset integertotal_count int64errors object[]
httpcode integermessage string
{
"meta": {
"pagination": {
"limit": 0,
"offset": 0,
"total_count": 0
}
},
"errors": [
{
"httpcode": 0,
"message": "string"
}
]
}