POST /oauth/auz/grants/{GrantID}/authenticate

Authenticates the resource owner. For SSO login, this operation renders the login domain; for LDAP domain, it accepts LDAP credentials such as username and password.

Authorization Roles/Permissions: Anyone can run this operation.

This topic includes the following sections:

HTTP Method

POST

URL

https://{oauth-provider-url}/oauth/auz/grants/{GrantID}/authenticate

Sample Request

The example below shows a request to authenticate.

Sample Request URL

https://{oauth-provider-url}/oauth/auz/grants/ge6ij9k4fbea/authenticate

Sample request headers

Accept: text/plain, */*; q=0.01

Sample request body

None.

Request Headers

For general information on request header values, refer to HTTP Request Headers.

Header	Description
Accept	application/json
Content-Type	application/x-www-form-urlencoded

Request Parameters

Parameter	Parm Type	Data Type	Required	Description
GrantID	Path	string	Required	The unique ID for a specific instance of an OAuth grant.
Identity_username	Form	string	Required for LDAP	The user's LDAP username.
Identity_password	Form	string	Required for LDAP	The user's LDAP password.

Response

If successful, this operation returns HTTP status code 200, with authentication information.

Sample Response

The sample response below shows successful completion of this operation.

Sample response headers

HTTP/1.1 200 OK
Content-Type: application/json
Expires: Fri, 21 Aug 2015 10:10:34 GMT

Sample response body

{
  "GrantID" : "m9rqb3u3rh1p",
  "GrantProvider" : "OAuth_acmepaymentscorp",
  "GrantStatus" : "Pending",
  "ResourceOwner" : "eng100"
}

Response Headers

For general information on response header values, refer to HTTP Response Headers.

Header	Description
Content-Type	application/json

Response Body

Name	Type	Description
GrantResponse	GrantResponse	Contains information about the response to an OAuth grant request, including grant status.

Error Codes/Messages

If the call is unsuccessful an error code/message is returned. One or more examples of possible errors for this operation are shown below.

Item	Value
401	Invalid username/password.
500	Invalid GrantID.
500	An error occurred processing the call.

More information about Akana OAuth API error messages.

Related Topics