OAuthClient

Summary

API Manager OAuth Credentials.

Description

API Manager OAuth Credentials.

Fields

Field Name Type Since Version Description
id String The client ID to be used in OAuth flows
cert String The PEM encodeded certificate used in JWT flow
secret String The client application secret to be used in OAuth flows
type String OAuth defines two client types, based on their ability to authenticate securely with the authorization server. Possible values public or confidential
enabled Boolean Flag disables the OAuth credentials so they can't be used in authentication
redirectUrls [String] The URL where the server will redirect the to present authorization codes or access tokens depending on the OAuth flow being executed
corsOrigins [String] The domains to allow access for browser-based clients
createdBy String The unique identifier for user that generated the OAuth credentials
createdOn Long Epoch/Unix time stamp when the OAuth credentials was created
applicationId String The application identifier associated with the OAuth credential

Example JSON

{
  "id" : "7b32f6c9-9e27-4def-87e2-247aadf7f583",
  "cert" : "-----BEGIN CERTIFICATE-----MIICUTC..............-----END CERTIFICATE-----",
  "secret" : "ddf27559-ace0-4c4f-b5e4-ecf2086fddc5",
  "type" : "public",
  "enabled" : true,
  "redirectUrls" : [ "https://example.com/callback" ],
  "corsOrigins" : [ "example.com" ],
  "createdBy" : "3e21b76a-defa-49ab-9682-a9cd60387e37",
  "createdOn" : 1364287486876,
  "applicationId" : null
}