Start linking an OpenID Connect identity

POST

/api/v1/auth/oidc/{provider}/link/start

curl --request POST \
  --url https://example.com/api/v1/auth/oidc/example/link/start \
  --header 'Authorization: Bearer <token>'

Starts linking an OpenID Connect identity. It requires a signed-in User with the account scope. It can return 401 if the session is missing or expired, 403 if access is denied and 429 if the request limit is reached. Route: /api/v1/auth/oidc/{provider}/link/start. Inputs: provider. A recent account assertion is required. Do not automatically replay this operation after an uncertain result.

Authorizations

• installationBearer
• browserSession

Parameters

Path Parameters

provider

required

string

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

Responses

200

Media typeapplication/json

object

authorization_url

required

string

state

required

string

Example^generated

{
  "authorization_url": "example",
  "state": "example"
}

429

Media typeapplication/json

object

code

required

string

message

required

string

Example^generated

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