SSO Initiation

admin.auth.session.sso.initiate

This API is used to start an SSO login process. The response to the login initiation provides the SSO vendor specific UI that should be launched to start the user journey for SSO login.

Endpoint

    POST v1/admin/auth/sso/initiate

HTTP Headers

Header	Value
Authorization	Bearer api_key.

Request Body

    {
        "username": "john.doe@example.com",
    }

Parameter	Type	Required	Description
username	String	Required	The email address of the user.

Response Body

    {
        "state": "lmkbn39KqgTXU8wSf",
        "nonce": "hjklop1XfXArN4tW8",
        "redirect": "https://dev-xcvrqauwz5wfy.us.auth0.com/authorize?client_id=jkljeS0239F38tzRbh7LvMi5w7LHP&response_type=code&scope=openid+profile+email&nonce=hjklop1XfXArN4tW8&redirect_uri=http%3A%2F%2Flocalhost%3A3000%2Flogin%2Fsso_callback&state=lmkbn39KqgTXU8wSf",
        "status_code": "A0000",
        "status_message": "success"
    }

Field	Type	Description
status code	String	Status code provided by Indee.
status_message	String	Message body of the status code.
state	String	A random string generated by the SSO provider during the initiation step. It is returned in the initiation API response and also included in the redirect URL after the user completes login. This value must be securely stored by the client and included in the SSO login API request to validate the session and protect against CSRF attacks.
nonce	String	A unique, cryptographically random string generated by the SSO provider during the initiation step. It is returned in the initiation API response and must be securely stored by the client. This value is used to associate the client session with the ID token and must be included in the SSO login API request to help prevent replay attacks.

Error Codes

Indee provides a comprehensive list of Error Codes. To know more, see Common Error and Success Codes.