OAuth Client

These endpoints let you manage OAuth clients in the system.

Get OAuth Clients

get

Return the OAuth clients.

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

pageintegerOptional

Page number

Default: 0Example: 0

sizeinteger · min: 1 · max: 50Optional

Page size

Default: 10Example: 10

Responses

200

OK

application/json

totalPagesintegerRequired

Total number of pages available

lastbooleanRequired

Indicates whether this is the last page

totalElementsintegerRequired

Total number of elements across all pages

numberOfElementsintegerRequired

Number of elements in the current page

firstbooleanRequired

Indicates whether this is the first page

sizeintegerRequired

Size of the page (number of elements per page)

numberintegerRequired

Current page number (zero-indexed)

400

Bad Request

get

/v1/oauth-clients

cURLPython SDK

curl -X GET \
  "https://api.catapa.com/v1/oauth-clients?page=0&size=10" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Tenant: your-tenant-id"

{
  "content": [
    {
      "id": "26972039-d1bc-11ef-ab12-0242ac120003",
      "clientId": "authorization_code_grant_type",
      "scope": "",
      "authorizedGrantTypes": "client_credentials,authorization_code,refresh_token",
      "authorities": "client",
      "webServerRedirectUri": "https://catapa.com",
      "authorizeAllEndpoints": false
    }
  ],
  "number": 0,
  "size": 10,
  "totalElements": 1,
  "first": true,
  "last": true,
  "numberOfElements": 1,
  "totalPages": 1
}

Get OAuth Client by Id

get

Return the OAuth client by Id.

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

OAuth Client ID

Example: f47ac10b-58cc-4372-a567-0e02b2c3d479

Responses

200

OK

application/json

idstringOptional

OAuth client unique identifier

clientIdstringOptional

OAuth client ID used for authentication

scopestringOptional

OAuth scopes granted to this client

authorizedGrantTypesstringOptional

Comma-separated list of authorized grant types (e.g., client_credentials, authorization_code, refresh_token)

authoritiesstringOptional

Authorities granted to this client

webServerRedirectUristringOptional

Redirect URI for web server flow

authorizeAllEndpointsbooleanOptional

Whether this client is authorized to access all endpoints

400

Bad Request

404

Not Found

get

/v1/oauth-clients/{id}

cURLPython SDK

curl -X GET \
  "https://api.catapa.com/v1/oauth-clients/f47ac10b-58cc-4372-a567-0e02b2c3d479" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Tenant: your-tenant-id"

{
  "id": "26972039-d1bc-11ef-ab12-0242ac120003",
  "clientId": "authorization_code_grant_type",
  "scope": "",
  "authorizedGrantTypes": "client_credentials,authorization_code,refresh_token",
  "authorities": "client",
  "webServerRedirectUri": "https://catapa.com",
  "authorizeAllEndpoints": false
}