Sign in

v16

OpenAPI 3.0.3Apache 2.0raw.githubusercontent.com2026-04-0886158866.0 KB
Dynamic Client Registration

Register Client

Register a client. This API is supposed to be used to implement a client registration endpoint that complies with RFC 7591 (OAuth 2.0 Dynamic Client Registration Protocol).

post/api/{serviceId}/client/registration

Path parameters

serviceIdstring required

A service ID.

Request body

jsonstring required

Client metadata in JSON format that complies with RFC 7591 (OAuth 2.0 Dynamic Client Registration Protocol).

tokenstring

The client registration access token. Used only for GET, UPDATE, and DELETE requests.

clientIdstring

The client's identifier. Used for GET, UPDATE, and DELETE requests

Response

Client registration completed successfully

resultCodestring

The code which represents the result of the API call.

resultMessagestring

A short message which explains the result of the API call.

action'BAD_REQUEST' | 'CREATED' | 'DELETED' | 'INTERNAL_SERVER_ERROR' | 'OK' | 'UNAUTHORIZED' | 'UPDATED'

The next action that the authorization server implementation should take.

responseContentstring

The content that the authorization server implementation is to return to the client application. Its format varies depending on the value of action parameter.

Example response

{
  "client": {
    "number": 1140735077,
    "serviceNumber": 715948317,
    "clientName": "My Test Client",
    "clientId": "1140735077",
    "clientSecret": "gXz97ISgLs4HuXwOZWch8GEmgL4YMvUJwu3er_kDVVGcA0UOhA9avLPbEmoeZdagi9yC_-tEiT2BdRyH9dbrQQ",
    "clientType": "PUBLIC",
    "redirectUris": [
      "https://example.com/callback"
    ],
    "responseTypes": [
      "CODE"
    ],
    "grantTypes": [
      "AUTHORIZATION_CODE"
    ]
  }
}