Jump to

• Request
• Response
• Examples

Start a Session

post

/sso/v1/sdk/session

Deprecated since 19.2.1

Request

Supported Media Types

• multipart/form-data

Body ()

Root Schema : schema

Type: object

Show Source

• authnToken(optional): string
  Authentication Token that was obtained from the previous authentication call to the /authenticate endpoint
• requestState(optional): string
  RequestState that was obtained from the previous authentication call to the /authenticate endpoint
• trustToken(optional): string
  Trust token obtained after trusting the browser

{
    "type":"object",
    "properties":{
        "requestState":{
            "description":"RequestState that was obtained from the previous authentication call to the /authenticate endpoint",
            "type":"string"
        },
        "authnToken":{
            "description":"Authentication Token that was obtained from the previous authentication call to the /authenticate endpoint",
            "type":"string"
        },
        "trustToken":{
            "description":"Trust token obtained after trusting the browser",
            "type":"string"
        }
    }
}

Back to Top

Response

200 Response

Auto submit HTML response

303 Response

Redirect to URL after successful creation of session

400 Response

Invalid request

401 Response

Unauthorized request

500 Response

Internal Server Error

Back to Top

Examples

The following examples show how to start a session by submitting a POST request on the REST resource using cURL. For more information about cURL, see Use cURL.

cURL Command

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.

curl
-X POST
-H "Content-Type:application/scim+json"
-H "Authorization: Bearer <Access Token Value>"
https://tenant-base-url/sso/v1/sdk/session

Example of a Request Body When Starting a Session

The following example shows the contents of the request body in JSON format when starting a session:

{ 
    "requestState": "Jbl8BW8ziNOx.....mJlybL2YHPPk",  
    "authnToken": "eyJraWQ......tW5Ru57v6phElxgQ"
 }

Example of a Response Body When Starting a Session

The following example shows the contents of the response body in JSON format when starting a session:

{
  "status": 303,
  "response": {
  }
}

Back to Top