Start sign-in to confirm an OpenID Connect identity
POST
/api/v1/auth/oidc/{provider}/reauth/start
const url = 'https://example.com/api/v1/auth/oidc/example/reauth/start';const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request POST \ --url https://example.com/api/v1/auth/oidc/example/reauth/start \ --header 'Authorization: Bearer <token>'Starts the sign-in to confirm 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}/reauth/start. Inputs: provider. Do not automatically replay this operation after an uncertain result.
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”provider
required
string
Configured OIDC provider name, as listed by GET /auth/options
Responses
Section titled “Responses”Media typeapplication/json
object
authorization_url
required
string
state
required
string
Examplegenerated
{ "authorization_url": "example", "state": "example"}Media typeapplication/json
object
code
required
string
message
required
string
Examplegenerated
{ "code": "example", "message": "example"}