Begin a provider sign-in

POST

/api/v1/auth/{provider}/login

curl --request POST \
  --url http://127.0.0.1:8080/api/v1/auth/example/login \
  --header 'Content-Type: application/json' \
  --header 'Origin: example' \
  --data '{ "invitation_token": "example", "link": true, "login": "example", "password": "example" }'

• A local instance on its default listener.

Available only when account authentication is enabled. Provider configuration is restart-bound. Local logout does not require an external provider. Responses must not be cached.

Authorizations

• None
• browserSession

Parameters

Path Parameters

provider

required

string

Header Parameters

Origin

required

string

X-CSRF-Token

string

Required when explicitly linking to the current account.

Request Body^required

Media typeapplication/json

object

invitation_token

string

link

Requires a current browser session and CSRF proof; callback rechecks that session.

boolean

login

string

password

string

Example^generated

{
  "invitation_token": "example",
  "link": true,
  "login": "example",
  "password": "example"
}

Responses

200

OIDC, SAML and managed providers return the authorization_url to navigate to. LDAP and trusted-proxy providers sign in directly and return the new session.

Media typeapplication/json

One of:

object

object

authorization_url

required

Where to send the browser to continue with an OIDC, SAML or managed provider.

string format: uri

object

object

csrf_token

required

string

invitation_accepted

required

boolean

user

required

object

display_name

required

string

id

required

string

instance_admin

required

boolean

key

additional properties

any

Example^generated

{
  "authorization_url": "https://example.com"
}

400

Structured authentication boundary failure

Media typeapplication/problem+json

object

code

required

string

detail

required

string

status

required

integer

title

required

string

type

required

string

Example^generated

{
  "code": "example",
  "detail": "example",
  "status": 1,
  "title": "example",
  "type": "example"
}

401

Structured authentication boundary failure

Media typeapplication/problem+json

object

code

required

string

detail

required

string

status

required

integer

title

required

string

type

required

string

Example^generated

{
  "code": "example",
  "detail": "example",
  "status": 1,
  "title": "example",
  "type": "example"
}

403

Structured authentication boundary failure

Media typeapplication/problem+json

object

code

required

string

detail

required

string

status

required

integer

title

required

string

type

required

string

Example^generated

{
  "code": "example",
  "detail": "example",
  "status": 1,
  "title": "example",
  "type": "example"
}

429

Structured authentication boundary failure

Media typeapplication/problem+json

object

code

required

string

detail

required

string

status

required

integer

title

required

string

type

required

string

Example^generated

{
  "code": "example",
  "detail": "example",
  "status": 1,
  "title": "example",
  "type": "example"
}

500

Structured authentication boundary failure

Media typeapplication/problem+json

object

code

required

string

detail

required

string

status

required

integer

title

required

string

type

required

string

Example^generated

{
  "code": "example",
  "detail": "example",
  "status": 1,
  "title": "example",
  "type": "example"
}