Component schema

OAuthClientRegistrationRequest

object1 direct reference

Definition

stringrequired

Human-readable name of the client.

string[]required

Array of allowed redirect URIs.

OAuthGrantType[]

Grant types the client intends to use.

OAuthResponseType[]

Response types the client intends to use.

OAuthTokenEndpointAuthMethod

Defaults to none if not specified. Only public clients are supported.

"none"

string

Space-separated list of scopes the client is requesting.

string

URL of the client's home page.

string

URL of the client's logo image.

Used by 1

These schemas and endpoints reference this type directly.

EndpointPOST /oauth/register

json

OpenAPI source12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152
{
  "properties": {
    "client_name": {
      "description": "Human-readable name of the client.",
      "type": "string"
    },
    "redirect_uris": {
      "description": "Array of allowed redirect URIs.",
      "type": "array",
      "items": {
        "type": "string",
        "format": "uri"
      }
    },
    "grant_types": {
      "description": "Grant types the client intends to use.",
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/OAuthGrantType"
      }
    },
    "response_types": {
      "description": "Response types the client intends to use.",
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/OAuthResponseType"
      }
    },
    "token_endpoint_auth_method": {
      "$ref": "#/components/schemas/OAuthTokenEndpointAuthMethod",
      "description": "Defaults to `none` if not specified. Only public clients are supported.\n"
    },
    "scope": {
      "description": "Space-separated list of scopes the client is requesting.",
      "type": "string"
    },
    "client_uri": {
      "description": "URL of the client's home page.",
      "type": "string",
      "format": "uri"
    },
    "logo_uri": {
      "description": "URL of the client's logo image.",
      "type": "string",
      "format": "uri"
    }
  },
  "required": [
    "client_name",
    "redirect_uris"
  ]
}