Skip to content
Savorum API

Begin a native sign-in

GET
/api/v1/auth/{provider}/native
curl --request GET \
  --url 'http://127.0.0.1:8080/api/v1/auth/example/native?redirect_uri=example&state=example&code_challenge=example&code_challenge_method=S256' \
  --header 'Authorization: Bearer <token>'

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

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
provider
required
string

Query Parameters

Section titled “Query Parameters”
redirect_uri
required
string

An exactly permitted return target: savorum://auth/callback.

state
required
string

16 to 256 unreserved characters, returned unchanged to the app.

code_challenge
required
string

Base64url SHA-256 of the app’s code verifier, without padding.

code_challenge_method
required
string
Allowed values: S256
link_ticket
string

A ticket from create-native-link-ticket. The return then carries a link code for finish-native-provider-link instead of a sign-in code.

Responses

Section titled “Responses”

303

Section titled “303”

Sets the browser-bound transaction cookie and redirects to the OIDC, SAML or managed provider. Open this URL in the app’s authentication browser, not with a native HTTP client.

400

Section titled “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
Examplegenerated
{
  "code": "example",
  "detail": "example",
  "status": 1,
  "title": "example",
  "type": "example"
}

401

Section titled “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
Examplegenerated
{
  "code": "example",
  "detail": "example",
  "status": 1,
  "title": "example",
  "type": "example"
}

403

Section titled “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
Examplegenerated
{
  "code": "example",
  "detail": "example",
  "status": 1,
  "title": "example",
  "type": "example"
}

429

Section titled “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
Examplegenerated
{
  "code": "example",
  "detail": "example",
  "status": 1,
  "title": "example",
  "type": "example"
}

500

Section titled “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
Examplegenerated
{
  "code": "example",
  "detail": "example",
  "status": 1,
  "title": "example",
  "type": "example"
}