POST v1/core/AuthToken

Creates a new auth token with the requested duration (max is 60 minutes) The auth token is then passed with all subsequent calls either on the query string or in the HTTP Auth header as a pbnb auth ticket

Request Information

Parameters

NameDescriptionAdditional information
auth

Define this parameter in the request body.

Request body formats

application/json, text/json

Sample:
{
  "Role": "sample string 1",
  "Scope": "sample string 2",
  "Token": "sample string 3",
  "Duration": 4,
  "Expires": "sample string 5",
  "Now": "sample string 6"
}

text/javascript

Sample:
{"Role":"sample string 1","Scope":"sample string 2","Token":"sample string 3","Duration":4,"Expires":"sample string 5","Now":"sample string 6"}

application/xml, text/xml

Sample:
<AuthToken xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/pbnb_models">
  <Duration>4</Duration>
  <Expires>sample string 5</Expires>
  <Now>sample string 6</Now>
  <Role>sample string 1</Role>
  <Scope>sample string 2</Scope>
  <Token>sample string 3</Token>
</AuthToken>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'AuthToken'.

application/bson

Sample:
�Rolesample string 1Scopesample string 2Tokensample string 3DurationExpiressample string 5Nowsample string 6

Response Information

Response body formats

application/json, text/json

Sample:
{
  "Success": true,
  "Data": {
    "Role": "sample string 1",
    "Scope": "sample string 2",
    "Token": "sample string 3",
    "Duration": 4,
    "Expires": "sample string 5",
    "Now": "sample string 6"
  },
  "ErrorCode": 2,
  "ErrorDescription": "sample string 3",
  "Meta": "sample string 4"
}

text/javascript

Sample:
{"Success":true,"Data":{"Role":"sample string 1","Scope":"sample string 2","Token":"sample string 3","Duration":4,"Expires":"sample string 5","Now":"sample string 6"},"ErrorCode":2,"ErrorDescription":"sample string 3","Meta":"sample string 4"}

application/xml, text/xml

Sample:
<PBNBReturnOfAuthTokenCA1DLPoZ xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/pbnb_models">
  <Data>
    <Duration>4</Duration>
    <Expires>sample string 5</Expires>
    <Now>sample string 6</Now>
    <Role>sample string 1</Role>
    <Scope>sample string 2</Scope>
    <Token>sample string 3</Token>
  </Data>
  <ErrorCode>2</ErrorCode>
  <ErrorDescription>sample string 3</ErrorDescription>
  <Meta>sample string 4</Meta>
  <Success>true</Success>
</PBNBReturnOfAuthTokenCA1DLPoZ>

application/bson

Sample:
�SuccessData�Rolesample string 1Scopesample string 2Tokensample string 3DurationExpiressample string 5Nowsample string 6ErrorCodeErrorDescriptionsample string 3Metasample string 4