OAuth20Settings Object

Includes information about the OAuth 2.0 settings for an API.

This object is used by the following operations:

The properties included in the OAuth20Settings object are listed below.

Property Type Required Description
AuthorizationEndpointURL anyURI Optional The API's OAuth 2.0 authorization endpoint URL, used to interact with the resource owner to obtain an authorization grant, if applicable.
TokenEndpointURL anyURI Optional The API's OAuth Resource Server endpoint, used by the client to obtain an OAuth 2.0 Access Token by presenting its authorization grant or refresh token, if applicable.
TokenEndpointRequestVerb string Optional The HTTP method used to retrieve the OAuth 2.0 Access Token from the API's OAuth 2.0 token endpoint URL, if applicable. Valid values: GET or POST.
BearerTokenMethods BearerTokenMethod[ ] (string) Optional

An array of one or more supported methods applicable to Bearer Token in Resource requests for this API, if any. Could be one or more of the following:

  • com.soa.oauth.bearer.token.method.auz.header
  • com.soa.oauth.bearer.token.method.form.param
  • com.soa.oauth.bearer.token.method.url.query.param