HTTP OAuth2 Authorization Mechanism

This is an abstract object type that cannot be instantiated.

The HTTP OAuth2 Authorization Mechanism is used to define HTTP OAuth2 authorization mechanism.

HTTP OAuth2 Authorization Mechanisms

The following HTTP OAuth2 Authorization Mechanisms are available:

These HTTP OAuth2 Authorization Mechanisms inherit the properties described below.

Parent

The HTTP OAuth2 Authorization Mechanism object inherits from HTTP Authorization Mechanism.

Dependencies

HTTP OAuth2 Authorization Mechanisms depend on the following objects:

HTTP OAuth2 Authorization Mechanism Properties

You can use configuration expressions to set property values at startup time. For details, see Property Value Substitution.

Basic Properties Advanced Properties

access-token-cache-enabled
access-token-cache-expiration
authzid-json-pointer
enabled
identity-mapper
required-scope

java-class

Basic Properties

Use the --advanced option to access advanced properties.

access-token-cache-enabled

Synopsis

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

No

Read-Only

No

access-token-cache-expiration

Synopsis

Token cache expiration

Default Value

None

Allowed Values

Lower limit: 0 seconds.

Upper limit: 2147483647 seconds.

Multi-valued

No

Required

No

Admin Action Required

None

Advanced

No

Read-Only

No

authzid-json-pointer

Synopsis

Specifies the JSON pointer to the value to use as Authorization ID. The JSON pointer is applied to the resolved access token JSON document.

Default Value

None

Allowed Values

A string.

Multi-valued

No

Required

Yes

Admin Action Required

None

Advanced

No

Read-Only

No

enabled

Synopsis

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

No

Read-Only

No

identity-mapper

Synopsis

Specifies the name of the identity mapper(s) to use in conjunction with the authzid-json-pointer to get the user corresponding to the acccess-token.

Default Value

None

Allowed Values

The name of an existing identity-mapper.

The referenced identity mapper(s) must be enabled when the HTTP OAuth2 Authorization Mechanism is enabled.

Multi-valued

Yes

Required

Yes

Admin Action Required

None

Advanced

No

Read-Only

No

required-scope

Synopsis

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

No

Read-Only

No

Advanced Properties

Use the --advanced option to access advanced properties.

java-class

Synopsis

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 extends or implements:

  • org.opends.server.protocols.http.authz.HttpAuthorizationMechanism

Multi-valued

No

Required

Yes

Admin Action Required

None

Advanced

Yes

Read-Only

No