Jump to

• Request
• Response
• Examples

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

303 Response

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

Back to Top

Examples

The following examples show how to initiate authentication using a remote Identity Provider (IdP) by submitting a POST request on the REST resource using cURL. For more information about cURL, see Use cURL.

Note:

The command in this example uses the URL structure https://tenant-base-url/resource-path, where tenant-base-url represents the Identity Service URL, and the resource path represents the Identity Service API. See Send Requests for the appropriate URL structure to use.

Example of a Request Body When Initiating Authentication Using a Remote IdP

The following example shows the contents of the request body in FORM POST format when initiating authentication using a social IdP to the /sso/v1/sdk/secure/idp endpoint:

requestState=value&idpName=value&idpType=SOCIAL&idpId=value&appName=name&clientID=value

Example of a Response Body When Initiating Authentication Using a Remote IdP

The following example shows the contents of the HTML response:

HTTP/1.1 302 See Other
Date: Tue, 30 Oct 2018 04:40:05 GMT
Content-Length: 0
Connection: keep-alive
Pragma: no-cache
Location: https://tenant-base-url/idp/sso
Set-cookie: ORA_OCIS_REQ_1=+fxgW2P7bgQayiki5P;Version=1;Path=/;Secure;HttpOnly
Expires: Sat, 01 Jan 2000 00:00:00 GMT
X-xss-protection: 1; mode=block
X-content-type-options: nosniff

Back to Top