Sign in

v1

latestOpenAPI 3.0.02026-07-141,4077,1665.2 MB
OAuth2 Client Public

Register an OAuth2 client

Register an OAuth2 client using the Dynamic Client Registration protocol defined in RFC 7591.

post/api/v2/oauth2/register

Request body

client_namestring required

Human-readable name of the client. Control characters are rejected.

client_uristring

URL of the home page of the client.

grant_typesOAuthClientRegistrationGrantType[]

OAuth 2.0 grant types the client may use. Defaults to authorization_code and refresh_token when omitted.

jwks_uristring

URL referencing the client's JSON Web Key Set.

logo_uristring

URL referencing a logo for the client.

policy_uristring

URL pointing to the client's privacy policy.

redirect_urisstring[] required

Array of redirection URI strings used by the client in redirect-based flows.

response_typesOAuthClientRegistrationResponseType[]

OAuth 2.0 response types the client may use. Only code is supported.

scopestring

Space-separated list of scope values the client may request.

token_endpoint_auth_methodstring

Requested authentication method for the token endpoint. Only none is supported.

tos_uristring

URL pointing to the client's terms of service.

Example request

{
  "client_name": "Example MCP Client",
  "client_uri": "https://example.com",
  "grant_types": [
    "authorization_code",
    "refresh_token"
  ],
  "jwks_uri": "https://example.com/.well-known/jwks.json",
  "logo_uri": "https://example.com/logo.png",
  "policy_uri": "https://example.com/privacy",
  "redirect_uris": [
    "https://example.com/oauth/callback"
  ],
  "response_types": [
    "code"
  ],
  "scope": "openid profile",
  "token_endpoint_auth_method": "none",
  "tos_uri": "https://example.com/tos"
}

Response

Created

client_idstring uuid required

Unique identifier assigned to the registered client.

client_namestring required

Human-readable name of the client.

grant_typesOAuthClientRegistrationGrantType[] required

OAuth 2.0 grant types registered for the client.

redirect_urisstring[] required

Redirection URIs registered for the client.

response_typesOAuthClientRegistrationResponseType[] required

OAuth 2.0 response types registered for the client.

token_endpoint_auth_methodstring required

Authentication method registered for the token endpoint. Always none.

Example response

{
  "client_id": "72b68208-36a6-11f0-b21b-da7ad0900002",
  "client_name": "Example MCP Client",
  "grant_types": [
    "authorization_code",
    "refresh_token"
  ],
  "redirect_uris": [
    "https://example.com/oauth/callback"
  ],
  "response_types": [
    "code"
  ],
  "token_endpoint_auth_method": "none"
}