POST api/v2.0/Authentication/Widget

Used to Authenticate to the Widgets Platform

Request Information

URI Parameters

None.

Body Parameters

An encrypted token, provided by the Connected Community CCAdmin Site

WidgetToken
NameDescriptionTypeAdditional information
token

string

None.

Request Formats

application/json, text/json

Sample:
{
  "token": "sample string 1"
}

application/xml, text/xml

Sample:
<WidgetToken xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/HigherLogic.API.Models.Enterprise">
  <token>sample string 1</token>
</WidgetToken>

Response Information

Resource Description

TenantInfo
NameDescriptionTypeAdditional information
IAMKey

globally unique identifier

None.

TenantShortName

string

None.

TenantCode

string

None.

DomainUrl

string

None.

DomainLoginUrl

string

None.

Response Formats

application/json, text/json

Sample:
{
  "IAMKey": "4c2e0a2d-5f2b-4002-9e22-d79ad2b64c21",
  "TenantShortName": "sample string 2",
  "TenantCode": "sample string 3",
  "DomainUrl": "sample string 4",
  "DomainLoginUrl": "sample string 5"
}

application/xml, text/xml

Sample:
<TenantInfo xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/HigherLogic.API.Models.Enterprise">
  <DomainLoginUrl>sample string 5</DomainLoginUrl>
  <DomainUrl>sample string 4</DomainUrl>
  <IAMKey>4c2e0a2d-5f2b-4002-9e22-d79ad2b64c21</IAMKey>
  <TenantCode>sample string 3</TenantCode>
  <TenantShortName>sample string 2</TenantShortName>
</TenantInfo>