Start OpenID Connect sign-in
POST
/api/v1/auth/oidc/{provider}/start
const url = 'https://example.com/api/v1/auth/oidc/example/start';const options = {method: 'POST'};
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/startStarts the OpenID Connect sign-in. No sign-in is required to start sign-in with the selected identity provider. It can return 429 if the request limit is reached. Route: /api/v1/auth/oidc/{provider}/start. Inputs: provider. Do not automatically replay this operation after an uncertain result.
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"}