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

Back to top

URL

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

Back to top

Sample Request

The example below shows a request to authenticate.

Request URL

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

Sample request headers

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

Sample request body

None.

Back to top

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

Back to top

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.

Back to top

Response

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

Back to top

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"
}

Back to top

Response Headers

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

Header Description
Content-Type application/json

Back to top

Response Body

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

Back to top

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.

Back to top

Related Topics