Start a native link

POST

/api/v1/auth/{provider}/native-link-tickets

curl --request POST \
  --url http://127.0.0.1:8080/api/v1/auth/example/native-link-tickets \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Origin: example' \
  --header 'X-CSRF-Token: example' \
  --data '{ "code_challenge": "example", "code_challenge_method": "S256" }'

• 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

• bearerToken
• browserSession

Parameters

Path Parameters

provider

required

string

Header Parameters

Origin

required

string

X-CSRF-Token

required

string

Request Body^required

Media typeapplication/json

object

code_challenge

required

Base64url SHA-256 of the app’s code verifier, without padding. The native entry must present the same challenge.

string

code_challenge_method

required

string

Allowed values: S256

Responses

200

A one-minute, single-use ticket bound to the current session and the PKCE challenge. Pass it as link_ticket to begin-native-provider-login with the same challenge.

Media typeapplication/json

object

link_ticket

required

string

Example^generated

{
  "link_ticket": "example"
}

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