Create User Session

Creates a new session

POST /api/portal/session

Try it

cURL

cURL

curl --request POST \
  --url http://sandbox.mintlify.com/api/portal/session \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "uniqueUserId": "<string>",
  "configuration": {
    "userDisplay": "<string>",
    "returnUrl": "<string>"
  }
}
'

200

{
  "sessionId": "<string>",
  "uniqueUserId": "<string>",
  "configuration": {
    "userDisplay": "<string>",
    "returnUrl": "<string>"
  }
}

Authorizations

x-api-key · string · header · required

Body

application/json

Payload to create a new session

uniqueUserId · string · required

Unique identifier for the user

configuration · object · required

Show child attributes

configuration. userDisplay · string · required

Display name for the user

configuration. returnUrl · string · required

URL to redirect the user after session creation

Response

200

application/json

Session created successfully

sessionId · string · required

The session identifier

uniqueUserId · string · required

Unique identifier for the user

configuration · object · required

Show child attributes

configuration. userDisplay · string · required

Display name for the user

configuration. returnUrl · string · required

URL to redirect the user after session creation