← Back to plugin index

OAuth 2.0 Resource
Description
An OAuth 2.0 resource configuration.
Type name
OAuth2Resource
Class
com.airlock.iam.oauth2.application.configuration.resource.OAuth2ResourceConfig
May be used by
OAuth 2.0 Resource Endpoint
License-Tags
OAuthServer
Properties
Resource Name (resourceName)
Description

The name of this resource.

This value will be part of the URL: /<loginapp-uri>/rest/oauth2/authorization-servers/<as-identifier>/resources/<resource-name>

Attributes
String
Mandatory
Validation RegEx: [a-zA-Z0-9._-]+
Example
username
Example
surname
Resource Content Providers (resourceProviders)
Description

A list of OAuth 2.0 resource content providers.

Each provider may contribute any number of claims to the final result of this resource.

Multiple claims with the same name can be configured if each has a claim condition which ensures that only one of them will be included at runtime.

Attributes
Plugin-List
Mandatory
Assignable plugins
OAuth 2.0 Date Context Data Resource OAuth 2.0 LocalDate Context Data Resource OAuth 2.0 SSO Ticket Resource OAuth 2.0 Static Resource OAuth 2.0 String Context Data Resource OAuth 2.0 User Roles Resource OAuth 2.0 Username Resource
Required Scopes (requiredScopes)
Description

Scopes required to access this resource.

If scope values are added to this list, the access token has to cover at least all configured scopes to be able to access this resource.

If this list is left empty, there are no required scopes to access this resource, meaning it is accessible to anyone presenting a valid access token, regardless of the presented scopes. Note however, that the individual resource providers may have a configured condition requiring that certain scopes be present to include the corresponding data element in the response.

Attributes
String-List
Optional
YAML Template (with default values) 

type: OAuth2Resource
id: OAuth2Resource-xxxxxx
displayName: 
comment: 
properties:
  requiredScopes:
  resourceName:
  resourceProviders: