Oauth-credentials (Section)#

Path: /facilities/http/client{id}/oauth-credentials

This enables the HTTP client to use OAuth 2.0 client credentials flow to obtain an access token for endpoint access

Parameters#

NameTypeRequiredDefaultDescription
client-idnon-empty-stringrequiredThe client id to use when obtaining an OAuth 2.0 access token
client-secretnon-empty-stringrequiredThe client secret to use when obtaining an OAuth 2.0 access token
send-client-credentials-in-authorization-headerbooleanoptionalfalsePasses the OAuth credentials in the Authorization header instead of POST body
scopemulti-value, scopeoptionalScopes to request when requesting a new access token from the OAuth 2.0 client
token-endpointurirequiredThe complete url to the token endpoint of the OAuth server used to retrieve the access token

Subsections#

NameTypeDescription
inner-client-or-legacy-settings OneOfNone

Was this helpful?