create session for user

ApiScope: manage.user.session.write
API Scope Level: ServiceSubscriberScope

Path Parameters

user_uuid string required

Query Parameters

ssoEntityId string
ssopartner string
source string

Responses

• 200
• 400
• 401
• 403
• 500

---

OK

application/json

application/x-protobuf

Schema

Example (from schema)

---

Schema

errors object[]
Array [
errorCode int32
errorTitle string
errorMessage string
]
warnings object[]
Array [
warningCode int32
warningTitle string
warningMessage string
]
apiRequestId string
session object
start string
end string
isImpersonate boolean
ssoPartner object
name string
type string
Possible values: [SAML_20]
description string
uuid string
attributes object
property name* string
domains object[]
Array [
name string
description string
uuid string
ssoPartnerDTO object
name string
type string
Possible values: [SAML_20]
description string
uuid string
attributes object
property name* string
]
id string

{
  "errors": [
    {
      "errorCode": 0,
      "errorTitle": "string",
      "errorMessage": "string"
    }
  ],
  "warnings": [
    {
      "warningCode": 0,
      "warningTitle": "string",
      "warningMessage": "string"
    }
  ],
  "apiRequestId": "string",
  "session": {
    "start": "string",
    "end": "string",
    "isImpersonate": true,
    "ssoPartner": {
      "name": "string",
      "type": "SAML_20",
      "description": "string",
      "uuid": "string",
      "attributes": {},
      "domains": [
        {
          "name": "string",
          "description": "string",
          "uuid": "string",
          "ssoPartnerDTO": {
            "name": "string",
            "type": "SAML_20",
            "description": "string",
            "uuid": "string",
            "attributes": {}
          }
        }
      ]
    },
    "id": "string"
  }
}

Schema

Example (from schema)

---

Schema

errors object[]
Array [
errorCode int32
errorTitle string
errorMessage string
]
warnings object[]
Array [
warningCode int32
warningTitle string
warningMessage string
]
apiRequestId string
session object
start string
end string
isImpersonate boolean
ssoPartner object
name string
type string
Possible values: [SAML_20]
description string
uuid string
attributes object
property name* string
domains object[]
Array [
name string
description string
uuid string
ssoPartnerDTO object
name string
type string
Possible values: [SAML_20]
description string
uuid string
attributes object
property name* string
]
id string

{
  "errors": [
    {
      "errorCode": 0,
      "errorTitle": "string",
      "errorMessage": "string"
    }
  ],
  "warnings": [
    {
      "warningCode": 0,
      "warningTitle": "string",
      "warningMessage": "string"
    }
  ],
  "apiRequestId": "string",
  "session": {
    "start": "string",
    "end": "string",
    "isImpersonate": true,
    "ssoPartner": {
      "name": "string",
      "type": "SAML_20",
      "description": "string",
      "uuid": "string",
      "attributes": {},
      "domains": [
        {
          "name": "string",
          "description": "string",
          "uuid": "string",
          "ssoPartnerDTO": {
            "name": "string",
            "type": "SAML_20",
            "description": "string",
            "uuid": "string",
            "attributes": {}
          }
        }
      ]
    },
    "id": "string"
  }
}

Bad Request

application/json

Schema

Example (from schema)

---

Schema

errors object[]
Array [
errorCode int32
errorTitle string
errorMessage string
]
warnings object[]
Array [
warningCode int32
warningTitle string
warningMessage string
]
apiRequestId string

{
  "errors": [
    {
      "errorCode": 0,
      "errorTitle": "string",
      "errorMessage": "string"
    }
  ],
  "warnings": [
    {
      "warningCode": 0,
      "warningTitle": "string",
      "warningMessage": "string"
    }
  ],
  "apiRequestId": "string"
}

Unauthorized

application/json

Schema

Example (from schema)

---

Schema

errors object[]
Array [
errorCode int32
errorTitle string
errorMessage string
]
warnings object[]
Array [
warningCode int32
warningTitle string
warningMessage string
]
apiRequestId string

{
  "errors": [
    {
      "errorCode": 0,
      "errorTitle": "string",
      "errorMessage": "string"
    }
  ],
  "warnings": [
    {
      "warningCode": 0,
      "warningTitle": "string",
      "warningMessage": "string"
    }
  ],
  "apiRequestId": "string"
}

Forbidden

application/json

Schema

Example (from schema)

---

Schema

errors object[]
Array [
errorCode int32
errorTitle string
errorMessage string
]
warnings object[]
Array [
warningCode int32
warningTitle string
warningMessage string
]
apiRequestId string

{
  "errors": [
    {
      "errorCode": 0,
      "errorTitle": "string",
      "errorMessage": "string"
    }
  ],
  "warnings": [
    {
      "warningCode": 0,
      "warningTitle": "string",
      "warningMessage": "string"
    }
  ],
  "apiRequestId": "string"
}

Internal Server Error

application/json

Schema

Example (from schema)

---

Schema

errors object[]
Array [
errorCode int32
errorTitle string
errorMessage string
]
warnings object[]
Array [
warningCode int32
warningTitle string
warningMessage string
]
apiRequestId string

{
  "errors": [
    {
      "errorCode": 0,
      "errorTitle": "string",
      "errorMessage": "string"
    }
  ],
  "warnings": [
    {
      "warningCode": 0,
      "warningTitle": "string",
      "warningMessage": "string"
    }
  ],
  "apiRequestId": "string"
}

POST /v2/user/:user_uuid/session

Authorization

name: basicAuthtype: httpscheme: basic

Request

Base URL

/manage

Username

Password

user_uuid — path required

ssoEntityId — query

ssopartner — query

source — query

Accept

application/jsonapplication/x-protobuf

curl / cURL

curl -L -X POST '/manage/v2/user/:user_uuid/session' \
-H 'Accept: application/json'

python / requests

curl -L -X POST '/manage/v2/user/:user_uuid/session' \
-H 'Accept: application/json'

go / native

curl -L -X POST '/manage/v2/user/:user_uuid/session' \
-H 'Accept: application/json'

nodejs / axios

curl -L -X POST '/manage/v2/user/:user_uuid/session' \
-H 'Accept: application/json'

ruby / Net::HTTP

curl -L -X POST '/manage/v2/user/:user_uuid/session' \
-H 'Accept: application/json'

csharp / RestSharp

curl -L -X POST '/manage/v2/user/:user_uuid/session' \
-H 'Accept: application/json'

php / cURL

curl -L -X POST '/manage/v2/user/:user_uuid/session' \
-H 'Accept: application/json'

java / OkHttp

curl -L -X POST '/manage/v2/user/:user_uuid/session' \
-H 'Accept: application/json'

powershell / RestMethod

curl -L -X POST '/manage/v2/user/:user_uuid/session' \
-H 'Accept: application/json'