initiateIdentityProviderAuthentication (v1)

Initiate Identity Provider authentication

Overview

Validates session and initiates authentication session in identity provider system. Rereturns URL to redirect user to the Identity Provider for authentication.

POST (/internal/v1/custom-auth/login:initiate)

Parameters

  • X-Request-ID (header): Request ID used for tracing. A new one will be generated if not provided.

Request Body

Responses

200 OK

400 Bad Request

Returned in case of an error, internal server error or invalid request

500 Internal Server Error

Returned in case of an error, internal server error or invalid request

Architecture

2 properties
correlationId string

Correlation ID to help correlate with status check request

initAuthDetails object

Details required to initiate authentication in Identity Provider

1 property
redirectUrl string

URL to redirect user to Identity Provider for authentication

2 properties

Returned in case of an error, internal server error or invalid request

error string

Error message

code string

Error code

2 properties

Returned in case of an error, internal server error or invalid request

error string

Error message

code string

Error code