POST api/VideoAnalysisService/Authenticate

Authenticates User and generates Bearer Access token

Request Information

URI Parameters

None.

Body Parameters

Credentials
NameDescriptionTypeAdditional information
UserName

Gets or sets the user name

string

None.

Password

Gets or set the password

string

None.

Request Formats

application/json, text/json

Sample:
{
  "UserName": "sample string 1",
  "Password": "sample string 2"
}

application/xml, text/xml

Sample:
<Credentials xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CSP.AI.Portal.Models">
  <Password>sample string 2</Password>
  <UserName>sample string 1</UserName>
</Credentials>

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 'Credentials'.

Response Information

Resource Description

Authentication Info with the generated token and expiry dates

AuthenticationInfo
NameDescriptionTypeAdditional information
access_token

string

None.

token_type

string

None.

expires_in

integer

None.

userName

string

None.

.issued

string

None.

.expires

string

None.

Response Formats

application/json, text/json

Sample:
{
  "access_token": "sample string 1",
  "token_type": "sample string 2",
  "expires_in": 3,
  "userName": "sample string 4",
  ".issued": "sample string 5",
  ".expires": "sample string 6"
}

application/xml, text/xml

Sample:
<AuthenticationInfo xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CSP.AI.Portal.Models">
  <Expires>sample string 6</Expires>
  <Issued>sample string 5</Issued>
  <access_token>sample string 1</access_token>
  <expires_in>3</expires_in>
  <token_type>sample string 2</token_type>
  <userName>sample string 4</userName>
</AuthenticationInfo>