GET /oauth/auz/grants/{GrantID}/details

Returns detailed information about the specified OAuth grant, including the list of scopes.

Authorization Roles/Permissions: Must be the resource owner.

This topic includes the following sections:

HTTP Method

GET

Back to top

URL

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

Back to top

Sample Request

The example below shows a request for the details associated with the specified grant.

Request URL

https://{oauth-provider-url}/oauth/auz/grants/mkset3es9h1l/details

Sample request headers

GET /oauth/auz/grants/ge6ij9k4fbea/details HTTP/1.1
Accept: */*
Cookie: OAuthToken_{OAuthProviderName}

Sample request body

Not applicable.

Back to top

Request Headers

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

Header Description
Accept application/json
   

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.

Back to top

Response

If successful, this operation returns HTTP status code 200, with details about the specified grant.

Back to top

Sample Response

The sample response below shows successful completion of this operation.

Sample response headers: application/json

HTTP/1.1 200 OK
Content-Type: application/json
Expires: Wed, 22 Jul 2015 14:23:30 GMT

Sample response body: application/json

{
  "Grant" : {
    "GrantID" : "ge6ij9k4fbea",
    "GrantProvider" : "OAuthAutomationacmepaymentscorp",
    "GrantType" : "authorization_code",
    "OpenIdConnectGrant" : false,
    "GrantStatus" : "Pending",
    "GrantExpirationDateTime" : 1438889001000,
    "GrantExpirationDateTimeInMillis" : 1438889001000,
    "GrantClient" : {
      "ClientID" : "acmepaymentscorp-3yo5B3eN5bX7wck9JzbF2o6i",
      "ClientName" : "AutoOauthTestAPP",
      "ClientDetails" : "Sample app for runtime",
      "Website" : "",
      "RedirectURI" : [ ],
      "ClientSubTitle" : "123",
      "Updated" : 1437582852000,
      "UpdatedAtInMillis" : 1437582852000
    },
    "GrantClientRedirectUri" : "http://{hostname}/ui/apps/acmepaymentscorp/_VcuNfhlXb0PE8hHDxAx9OhA/resources/console/global/oauthclientredirect.html?dynamic=true",
    "ResourceOwnerUserInfo" : {
      "DomainName" : "LdapAutomationacmepaymentscorp",
      "UID" : "eng100"
    },
    "GrantResourceScope" : {
      "Resource" : [ {
        "Name" : "Scope1",
        "ShortDescription" : "Scope to work on OAuth",
        "LongDescription" : "",
        "ResourcePath" : "Scope1"
      } ]
    },
    "GrantIssuedDateTime" : 1437593001000,
    "GrantIssuedDateTimeInMillis" : 1437593001000,
    "GrantUpdatedDateTime" : 1437593009000,
    "GrantUpdatedDateTimeInMillis" : 1437593009000,
    "ResponseType" : "code"
  }
}

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
GrantDetail GrantDetail Contains information details about an OAuth grant.

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
500 Invalid GrantID.
500 An error occurred processing the call.

More information about Akana OAuth API error messages.

Back to top

Related Topics