GET api/v7/Security/ValidateToken?token={token}

Validates an issued token

Request Information

URI Parameters

NameDescriptionTypeRequired?Additional information
token *

the previously issued token string

string

Yes

None.

Body Parameters

None.

Response Information

Resource Description

An AuthenticationResponse which contains the issued token and user information

Authentication Response
NameDescriptionType
message

Response Message

string
accessToken

Access Token

Access Token
userInfo

User Information

User Info
orgInfo

Organization Information

Organization Information

Response Formats

application/json, text/json

Sample:
{
  "accessToken": {
    "token": "ASToken MDEzM2Q0YWItMjA3ZC00MzA2LWIzYWQtOTFmNTU5YjVkZjZiOjIwMTUwMTEyMTYwMjQ2",
    "idleTime": 0,
    "maxIdleTime": 1800,
    "maxSessionTime": 14400,
    "remainingTime": 14400
  },
  "userInfo": {
    "roles": [
      {
        "roleCode": "100",
        "roleName": "admin"
      }
    ],
    "passwordReset": false,
    "passwordExpirationDays": 63,
    "userId": "administrator",
    "firstName": "Default",
    "lastName": "Administrator",
    "displayName": "Default Administrator",
    "alternateId": "alt584102",
    "primaryLanguage": "en-US",
    "secondaryLanguage": "en-US"
  },
  "orgInfo": {
    "tenantName": "Default",
    "orgName": "Corporate",
    "orgLevelName": "Corporate",
    "isLowestLevel": false,
    "defaultLanguage": "en-US"
  }
}

application/xml, text/xml

Sample:
<AuthenticationResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <accessToken>
    <token>ASToken MDEzM2Q0YWItMjA3ZC00MzA2LWIzYWQtOTFmNTU5YjVkZjZiOjIwMTUwMTEyMTYwMjQ2</token>
    <idleTime>0</idleTime>
    <maxIdleTime>1800</maxIdleTime>
    <maxSessionTime>14400</maxSessionTime>
    <remainingTime>14400</remainingTime>
  </accessToken>
  <userInfo>
    <userId>administrator</userId>
    <firstName>Default</firstName>
    <lastName>Administrator</lastName>
    <displayName>Default Administrator</displayName>
    <alternateId>alt584102</alternateId>
    <primaryLanguage>en-US</primaryLanguage>
    <secondaryLanguage>en-US</secondaryLanguage>
    <customerAuditDate xsi:nil="true" />
    <roles>
      <Role>
        <roleCode>100</roleCode>
        <roleName>admin</roleName>
        <customerAuditDate xsi:nil="true" />
      </Role>
    </roles>
    <passwordReset>false</passwordReset>
    <passwordExpirationDays>63</passwordExpirationDays>
  </userInfo>
  <orgInfo>
    <tenantName>Default</tenantName>
    <orgName>Corporate</orgName>
    <orgLevelName>Corporate</orgLevelName>
    <isLowestLevel>false</isLowestLevel>
    <defaultLanguage>en-US</defaultLanguage>
  </orgInfo>
</AuthenticationResponse>