get session for sessionID
ApiScope: manage.user.session.read
API Scope Level: ServiceSubscriberScope
Path Parameters
session_id string required
Query Parameters
validate boolean
Responses
- 200
- 400
- 401
- 403
- 500
OK
application/json
application/x-protobuf
Schema
Example (from schema)
Schema
errors object[]
warnings object[]
apiRequestId string
session object
{
"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",
"user": {
"firstName": "string",
"lastName": "string",
"userName": "string",
"email": "string",
"phone": "string",
"passwordExpires": "string",
"forcePasswordChange": true,
"password": "string",
"nickName": "string",
"textNumber": "string",
"uuid": "string",
"pin": 0,
"roleName": "string",
"latestInviteStatus": "string",
"latestInviteDate": "string",
"calendarUuid": "string",
"userAuthorities": [
{
"authority": "string",
"description": "string"
}
],
"userFeatures": [
{
"key": "string",
"name": "string",
"description": "string",
"signUpUrl": "string",
"informationUrl": "string",
"email": "string",
"uuid": "string",
"category": "string"
}
],
"userPreferences": [
{
"keyName": "string",
"value": "string",
"promptType": "string",
"possibleValues": "string",
"description": "string"
}
],
"dealerAssociates": [
{
"id": 0,
"uuid": "string",
"userUuid": "string",
"department": {
"id": 0,
"name": "string",
"uuid": "string",
"calendarUuid": "string",
"brokerNumber": "string",
"communicationGroup": "string",
"departmentType": "string",
"phoneNumber": "string",
"textNumber": "string",
"emailAddress": "string",
"contactFName": "string",
"contactLName": "string",
"dealer": {
"id": 0,
"name": "string",
"uuid": "string",
"isValid": true
}
}
}
]
}
}
}
Schema
Example (from schema)
Schema
errors object[]
warnings object[]
apiRequestId string
session object
{
"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",
"user": {
"firstName": "string",
"lastName": "string",
"userName": "string",
"email": "string",
"phone": "string",
"passwordExpires": "string",
"forcePasswordChange": true,
"password": "string",
"nickName": "string",
"textNumber": "string",
"uuid": "string",
"pin": 0,
"roleName": "string",
"latestInviteStatus": "string",
"latestInviteDate": "string",
"calendarUuid": "string",
"userAuthorities": [
{
"authority": "string",
"description": "string"
}
],
"userFeatures": [
{
"key": "string",
"name": "string",
"description": "string",
"signUpUrl": "string",
"informationUrl": "string",
"email": "string",
"uuid": "string",
"category": "string"
}
],
"userPreferences": [
{
"keyName": "string",
"value": "string",
"promptType": "string",
"possibleValues": "string",
"description": "string"
}
],
"dealerAssociates": [
{
"id": 0,
"uuid": "string",
"userUuid": "string",
"department": {
"id": 0,
"name": "string",
"uuid": "string",
"calendarUuid": "string",
"brokerNumber": "string",
"communicationGroup": "string",
"departmentType": "string",
"phoneNumber": "string",
"textNumber": "string",
"emailAddress": "string",
"contactFName": "string",
"contactLName": "string",
"dealer": {
"id": 0,
"name": "string",
"uuid": "string",
"isValid": true
}
}
}
]
}
}
}
Bad Request
application/json
Schema
Example (from schema)
Schema
errors object[]
warnings object[]
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[]
warnings object[]
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[]
warnings object[]
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[]
warnings object[]
apiRequestId string
{
"errors": [
{
"errorCode": 0,
"errorTitle": "string",
"errorMessage": "string"
}
],
"warnings": [
{
"warningCode": 0,
"warningTitle": "string",
"warningMessage": "string"
}
],
"apiRequestId": "string"
}
GET /v2/user/session/:session_id
Authorization
name: basicAuthtype: httpscheme: basic
Request
Request
curl / cURL
curl -L -X GET '/manage/v2/user/session/:session_id' \
-H 'Accept: application/json'
python / requests
curl -L -X GET '/manage/v2/user/session/:session_id' \
-H 'Accept: application/json'
go / native
curl -L -X GET '/manage/v2/user/session/:session_id' \
-H 'Accept: application/json'
nodejs / axios
curl -L -X GET '/manage/v2/user/session/:session_id' \
-H 'Accept: application/json'
ruby / Net::HTTP
curl -L -X GET '/manage/v2/user/session/:session_id' \
-H 'Accept: application/json'
csharp / RestSharp
curl -L -X GET '/manage/v2/user/session/:session_id' \
-H 'Accept: application/json'
php / cURL
curl -L -X GET '/manage/v2/user/session/:session_id' \
-H 'Accept: application/json'
java / OkHttp
curl -L -X GET '/manage/v2/user/session/:session_id' \
-H 'Accept: application/json'
powershell / RestMethod
curl -L -X GET '/manage/v2/user/session/:session_id' \
-H 'Accept: application/json'