Note: this component is designated "advanced", which means that objects of this type are not expected to be created or altered in most environments. If you believe that such a change is necessary, you may want to contact support in order to understand the potential impact of that change.
The Static Bearer Token HTTP Authorization Method may be used to authorize HTTP requests with an explicitly provided OAuth 2.0 bearer token.
The Static Bearer Token HTTP Authorization Method component inherits from the HTTP Authorization Method
The following components have a direct aggregation relation from Static Bearer Token HTTP Authorization Methods:
The properties supported by this managed object are as follows:
| Basic Properties: | Advanced Properties: |
|---|---|
| description | None |
| enabled | |
| oauth-token-passphrase-provider |
| Description | A description for this HTTP Authorization Method |
| Default Value | None |
| Allowed Values | A string |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
| Description | Indicates whether this HTTP Authorization Method is enabled for use in the server. |
| Default Value | None |
| Allowed Values | true false |
| Multi-Valued | No |
| Required | Yes |
| Admin Action Required | None. Modification requires no further action |
oauth-token-passphrase-provider
| Description | A passphrase provider to use to obtain the OAuth 2.0 bearer token to use to authenticate to the HTTP server. |
| Default Value | None |
| Allowed Values | The DN of any Passphrase Provider. The OAuth token passphrase provider must be enabled. |
| Multi-Valued | No |
| Required | Yes |
| Admin Action Required | None. Modification requires no further action |
To list the configured HTTP Authorization Methods:
dsconfig list-http-authorization-methods
[--property {propertyName}] ...
To view the configuration for an existing HTTP Authorization Method:
dsconfig get-http-authorization-method-prop
--method-name {name}
[--tab-delimited]
[--script-friendly]
[--property {propertyName}] ...
To update the configuration for an existing HTTP Authorization Method:
dsconfig set-http-authorization-method-prop
--method-name {name}
(--set|--add|--remove) {propertyName}:{propertyValue}
[(--set|--add|--remove) {propertyName}:{propertyValue}] ...
To create a new Static Bearer Token HTTP Authorization Method:
dsconfig create-http-authorization-method
--method-name {name}
--type static-bearer-token
--set enabled:{propertyValue}
--set oauth-token-passphrase-provider:{propertyValue}
[--set {propertyName}:{propertyValue}] ...
To delete an existing HTTP Authorization Method:
dsconfig delete-http-authorization-method
--method-name {name}