POST api/authorization/authenticate

Authenticates the username/password name-value pair. Returns a Token (Guid).

Request Information

URI Parameters

None.

Body Parameters

The parameters.

AuthenticateUserParameters
NameDescriptionTypeAdditional information
username

Gets or sets the User Name.

string

None.

password

Gets or sets User's Password.

string

None.

Request Formats

application/json, text/json

Sample:
{
  "username": "sample string 1",
  "password": "sample string 2"
}

application/xml, text/xml

Sample:
<AuthenticateUserParameters xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Nbdc.WebServices.Models.Authorization">
  <password>sample string 2</password>
  <username>sample string 1</username>
</AuthenticateUserParameters>

Response Information

Resource Description

Valid token if authorized successfully.

AuthenticateUserResponse
NameDescriptionTypeAdditional information
token

Gets the response body.

globally unique identifier

None.

fullName

Gets the full name.

string

None.

Response Formats

application/json, text/json

Sample:
{
  "token": "f8f5abc2-3bb9-4a21-b084-d3c51f36b4ca",
  "fullName": "sample string 2"
}

application/xml, text/xml

Sample:
<AuthenticateUserResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Nbdc.WebServices.Models.Authorization">
  <fullName>sample string 2</fullName>
  <token>f8f5abc2-3bb9-4a21-b084-d3c51f36b4ca</token>
</AuthenticateUserResponse>