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

Returns information about the OAuth Provider, based on the GrantID.

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}/provider

Back to top

Sample Request

The example below shows a request for the OAuth provider details.

Request URL

https://{oauth-provider-url}/oauth/auz/provider

Sample request headers

GET /oauth/auz/provider HTTP/1.1
Accept: */*

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 the OAuth provider details.

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

{
  "ResourceOwnerIdentitySystemName" : "LdapAutomationacmepaymentscorp",
  "AuthorizationCodeGrantType" : {
    "AuthorizationCodeExpirationTimeInSeconds" : 600,
    "AccessTokenExpirationTimeInSeconds" : 1296000,
    "IssueRefreshTokens" : true,
    "GrantExpirationTimeInSeconds" : 1296000
  },
  "ClientCredentialsGrantType" : {
    "AccessTokenExpirationTimeInSeconds" : 1296000,
    "GrantExpirationTimeInSeconds" : 1296000
  },
  "ImplicitGrantType" : {
    "AccessTokenExpirationTimeInSeconds" : 1296000,
    "GrantExpirationTimeInSeconds" : 1296000
  },
  "ResourceOwnerCredentialsGrantType" : {
    "AccessTokenExpirationTimeInSeconds" : 1296000,
    "IssueRefreshTokens" : true,
    "GrantExpirationTimeInSeconds" : 1296000
  },
  "JWTBearerGrantType" : {
    "AccessTokenExpirationTimeInSeconds" : 1296000,
    "IssueRefreshTokens" : true,
    "GrantExpirationTimeInSeconds" : 1296000,
    "AllowedClockSkewInSeconds" : 600,
    "JWTIssuedByThisProvider" : true
  },
  "AccessTokenType" : "Bearer",
  "ResourceHierarchy" : {
    "Resource" : [ {
      "Name" : "Scope1",
      "ShortDescription" : "Scope to work on OAuth",
      "LongDescription" : "",
      "ResourcePath" : "Scope1",
      "DefaultResource" : true,
      "UserAuthorizationRequired" : true
    }, {
      "Name" : "openid",
      "ShortDescription" : "OpenID Connect scope",
      "LongDescription" : "OpenID Connect requests MUST contain the openid scope value. If this scope value is not present, the requests would be processed as OAuth2.0 requests.",
      "ResourcePath" : "openid",
      "DefaultResource" : false,
      "UserAuthorizationRequired" : true
    }, {
      "Name" : "scope",
      "ShortDescription" : "Consented scope scope",
      "LongDescription" : "This scope value requests access to the consented scopes in scope claim in id_token or UserInfo response.",
      "ResourcePath" : "scope",
      "DefaultResource" : false,
      "UserAuthorizationRequired" : true
    } ]
  },
  "GrantPropertiesMetadata" : {
    "GrantPropertyMetadata" : [ {
      "Name" : "OAuthPropertyId",
      "Description" : "OAuthPropertyId",
      "Label" : "OAuthProperty"
    } ]
  },
  "ProviderBrandDetails" : {
    "LogoURL" : "",
    "Footer" : "",
    "AuthorizationServerURL" : "http://acmepaymentscorp/"
  },
  "OpenIdConnectSupported" : true,
  "IdTokenSigningAlgorithm" : "RS256",
  "IdTokenEncryptionKeyManagementAlgorithm" : "none",
  "IdTokenContentEncryptionAlgorithm" : "A128CBC-HS256",
  "IdTokenExpirationTimeInSeconds" : 12344,
  "JwkExpirationTimeInSeconds" : 60,
  "GrantScopeSetting" : "provider_scope"
}

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
OAuthProvider OAuthProvider Contains information about an OAuth provider.

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
404

The resource could not be found.

For example, you might get this if there is a typo in the URL.

500 Invalid GrantID.
500 An error occurred processing the call.

More information about Enterprise API Platform API error messages.

Back to top

Related Topics