Note: this is an abstract component, that cannot be instantiated.
The HTTP Oauth2 Authorization Mechanism is used to define HTTP OAuth2 authorization mechanism.
The following HTTP Oauth2 Authorization Mechanisms are available in the server :
These HTTP Oauth2 Authorization Mechanisms inherit from the properties described below.
The HTTP Oauth2 Authorization Mechanism component inherits from the HTTP Authorization Mechanism
The following components have a direct AGGREGATION relation FROM HTTP Oauth2 Authorization Mechanisms :
A description of each property follows.
| Basic Properties: | Advanced Properties: |
|---|---|
| ↓ access-token-cache-enabled | ↓ java-class |
| ↓ access-token-cache-expiration | |
| ↓ authzid-json-pointer | |
| ↓ enabled | |
| ↓ identity-mapper | |
| ↓ required-scope |
| Description | Indicates whether the HTTP Oauth2 Authorization Mechanism is enabled for use. |
| Default Value | false |
| Allowed Values | true false |
| Multi-valued | No |
| Required | Yes |
| Admin Action Required | None |
| Advanced Property | No |
| Read-only | No |
| Description | Token cache expiration |
| Default Value | None |
| Allowed Values | A duration Syntax. Lower limit is 0 seconds. Upper limit is 2147483647 seconds. |
| Multi-valued | No |
| Required | No |
| Admin Action Required | None |
| Advanced Property | No |
| Read-only | No |
| Description | Specifies the JSON pointer to the value to use as Authorization ID. The JSON pointer is applied to the resolved access token JSON document. (example: /uid) |
| Default Value | None |
| Allowed Values | A String |
| Multi-valued | No |
| Required | Yes |
| Admin Action Required | None |
| Advanced Property | No |
| Read-only | No |
| Description | Indicates whether the HTTP Authorization Mechanism is enabled. |
| Default Value | None |
| Allowed Values | true false |
| Multi-valued | No |
| Required | Yes |
| Admin Action Required | None |
| Advanced Property | No |
| Read-only | No |
| Description | > Specifies the name of the identity mapper to use in conjunction with the authzid-json-pointer to get the user corresponding to the acccess-token. |
| Default Value | None |
| Allowed Values | The DN of any Identity Mapper. The referenced identity mapper must be enabled when the HTTP Oauth2 Authorization Mechanism is enabled. |
| Multi-valued | No |
| Required | Yes |
| Admin Action Required | None |
| Advanced Property | No |
| Read-only | No |
| Description | Scopes required to grant access to the service. |
| Default Value | None |
| Allowed Values | A String |
| Multi-valued | Yes |
| Required | Yes |
| Admin Action Required | None |
| Advanced Property | No |
| Read-only | No |
| Description | Specifies the fully-qualified name of the Java class that provides the HTTP Authorization Mechanism implementation. |
| Default Value | None |
| Allowed Values | A java class that implements or extends the class(es) : org.opends.server.protocols.http.authz.HttpAuthorizationMechanism |
| Multi-valued | No |
| Required | Yes |
| Admin Action Required | None |
| Advanced Property | Yes |
| Read-only | No |