Complete a SAML sign-in

POST

/api/v1/auth/{provider}/acs

curl --request POST \
  --url http://127.0.0.1:8080/api/v1/auth/example/acs \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data RelayState=example \
  --data SAMLResponse=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.

Parameters

Path Parameters

provider

required

string

Request Body^required

Media typeapplication/x-www-form-urlencoded

object

RelayState

required

string

SAMLResponse

required

string

Example^generated

RelayState=example&SAMLResponse=example

Responses

303

Successful sign-in creates an ordinary secure session and opens account settings, or the library home for a managed provider. A sign-in or link started at the native entry instead redirects to its return target with code and state, or with error (access_denied or authentication_failed) and state, and sets no browser session. A link code changes nothing until finish-native-provider-link confirms it.

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"
}