POST api/Authenticate

This method will allow OCP to verify the credentials of a user when the user is migrating. The api will also return the authorization levels for the user.

Request Information

URI Parameters

None.

Body Parameters

AuthenticateCredentials
NameDescriptionTypeAdditional information
username

string

None.
password

string

None.
portal

string

None.

Request Formats

application/json, text/json

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

application/xml, text/xml

Sample: 
<AuthenticateCredentials xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RDOCPWebAPI.SupportClasses">
  <portal>sample string 3</portal>
  <password>sample string 2</password>
  <username>sample string 1</username>
</AuthenticateCredentials>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Returns Portal user id, GUID, Status, Roles and Deep links

IHttpActionResult

None.

Response Formats

application/json, text/json, application/xml, text/xml

Sample:

Sample not available.