Register an OAuth client

POST

/api/v1/oauth/register

curl --request POST \
  --url http://localhost:3000/api/v1/oauth/register \
  --header 'Content-Type: application/json' \
  --data '{ "client_name": "example", "redirect_uris": [ "example" ], "grant_types": [ "example" ] }'

RFC 7591 dynamic registration. Public clients: no secret, PKCE (S256) instead. Redirects: https, http to loopback, or an app scheme.

No key needed.

Request Body^required

Media typeapplication/json

object

client_name

string

redirect_uris

Array<string>

grant_types

Array<string>

Example^generated

{
  "client_name": "example",
  "redirect_uris": [
    "example"
  ],
  "grant_types": [
    "example"
  ]
}

Responses

201

The client

Media typeapplication/json

object

client_id

required

string

client_name

required

string

redirect_uris

required

Array<string>

Example^generated

{
  "client_id": "example",
  "client_name": "example",
  "redirect_uris": [
    "example"
  ]
}

default

An error

Media typeapplication/json

object

error

required

object

code

required

string

message

required

string

detail

Example^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "detail": "example"
  }
}