Complete OpenID Connect sign-in

POST

/api/v1/auth/oidc/{provider}/callback

curl --request POST \
  --url https://example.com/api/v1/auth/oidc/example/callback \
  --header 'Content-Type: application/json' \
  --data '{ "code": "example", "installation_name": "example", "kind": "web", "state": "example" }'

Completes the OpenID Connect sign-in. The request must contain a valid OpenID Connect callback. A signed-in User is not needed. It can return 429 if the request limit is reached. Route: /api/v1/auth/oidc/{provider}/callback. Inputs: provider. Do not automatically replay this operation after an uncertain result.

Parameters

Path Parameters

provider

required

string

Configured OIDC provider name, as listed by GET /auth/options

Request Body^required

Media typeapplication/json

object

code

required

string

installation_name

string | null

kind

One of:

string

string

Allowed values: web installation

null

null

state

required

string

Responses

200

Media typeapplication/json

object

bearer_token

string | null

user

required

object

disabled

required

boolean

display_name

required

string

id

required

string format: uuid

role

required

string

Allowed values: owner admin member guest

username

required

string

Example

{
  "user": {
    "role": "owner"
  }
}

429

Too many requests

Media typeapplication/json

object

code

required

string

message

required

string

Example^generated

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