Jump to

• Request
• Response

Initiate Authentication Using a Remote IdP

post

/sso/v1/sdk/idp

Deprecated since 19.1.4

Request

Supported Media Types

• multipart/form-data

Body ()

Root Schema : schema

Type: object

Show Source

• clientId: string
  ClientId of the trusted application that initiates the authentication. If the trusted application that initiates the authentication and the custom UI application are the same, then this should be the clientId of the custom UI application
• idpId: string
  Id of the selected Identity Provider
• idpName: string
  Name of the selected Identity Provider
• idpType: string
  Type of the selected Identity Provider
• requestState: string
  RequestState that was obtained in the previous authentication call to the /authenticate endpoint

{
    "type":"object",
    "properties":{
        "requestState":{
            "description":"RequestState that was obtained in the previous authentication call to the /authenticate endpoint",
            "type":"string"
        },
        "idpId":{
            "description":"Id of the selected Identity Provider",
            "type":"string"
        },
        "idpName":{
            "description":"Name of the selected Identity Provider",
            "type":"string"
        },
        "idpType":{
            "description":"Type of the selected Identity Provider",
            "type":"string"
        },
        "clientId":{
            "description":"ClientId of the trusted application that initiates the authentication. If the trusted application that initiates the authentication and the custom UI application are the same, then this should be the clientId of the custom UI application",
            "type":"string"
        }
    },
    "required":[
        "requestState",
        "idpId",
        "idpName",
        "idpType",
        "clientId"
    ]
}

Back to Top

Response

Supported Media Types

• application/json

303 Response

Redirect to the social identity provider or display an error message.

Back to Top