GET /oauth/admin/provider

Returns information about an OAuth provider.

Authorization Roles/Permissions: Must be the resource owner, provider admin, or client admin. Authentication cookie is required.

This topic includes the following sections:

HTTP Method

GET

Back to top

URL

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

Back to top

Sample Request

The example below shows a request for information about the OAuth Provider.

Request URL

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

Sample request headers

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
OAuthToken_{OAuthProviderName} The OAuth cookie that identifies the logged-in user with the provider. Depending on the operation being used and the context, the authenticated user could be the resource owner, the administrator, the client app administration, or the OAuth Provider. The cookie is returned after logging in with the POST /oauth/login operation.

Back to top

Request Parameters

None.

Back to top

Response

If successful, this operation returns HTTP status code 200, with information about the OAuth Provider.

Back to top

Sample Response

The sample response below shows successful completion of this operation.

Sample response headers: application/json

Status Code: 200 OK
Content-Type: application/json
Expires: Wed, 26 Aug 2015 16:22:30 GMT

Sample response body: application/json

{
  "ResourceOwnerIdentitySystemName" : "Ldapacmepaymentscorp",
  "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.com:9900/",
    "AdditionalVirtualHosts" : [ ],
    "SSLRequired" : false
  },
  "OpenIdConnectSupported" : true,
  "IdTokenSigningAlgorithm" : "HS256",
  "IdTokenEncryptionKeyManagementAlgorithm" : "none",
  "IdTokenContentEncryptionAlgorithm" : "A128CBC-HS256",
  "IdTokenExpirationTimeInSeconds" : 12344,
  "JwkExpirationTimeInSeconds" : 12344
}

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
401 Unauthorized. For example, you would get this response if you didn't include the OAuthToken_{OAuthProviderName} cookie, or if you included an invalid cookie.
500 An error occurred processing the call.

More information about Enterprise API Platform API error messages.

Back to top

Related Topics