← Back to plugin index

OAuth 2.0 Scope Translation Entry
Description
Defines translation rules for OAuth 2.0 scopes to human-readable explanations.
Type name
OAuth2ScopeTranslationEntry
Class
com.airlock.iam.oauth2.application.configuration.scope.OAuth2ScopeTranslationEntry
May be used by
OAuth 2.0 Scope Translator
License-Tags
OAuthServer
Properties
Scope Pattern (scopePattern)
Description
Regular expression matched against the OAuth 2.0 scopes. If the expression matches, the "Translation Key" is used instead of the scope name.
Attributes
RegEx
Mandatory
Translation Key (translationKey)
Description

Specifies the property key for the scope's human-readable name or description. The system looks up translations in the following order:

1. Checks strings_xx.properties file for the specified key

2. If not found, frontend translations in the xx.properties files of the Loginapp SDK are used, using the following pattern: <prefix>.<scope>

3. If there is no frontend translation, the scope name is used as is

Available frontend translation prefixes by context:

Authentication Flow: authentication.oauth2.consent.scope. OAuth 2.0 Consent Management: protected.oauth2.consents.consent.scope. OAuth 2.0 Session Management: protected.oauth2.sessions.session.scope.

Example frontend translations for the scope read on all three pages:


	authentication.oauth2.consent.scope.read=Read user profile data
	protected.oauth2.consents.consent.scope.read=Read user profile data
	protected.oauth2.sessions.session.scope.read=Read user profile data

Attributes
String
Mandatory
YAML Template (with default values) 

type: OAuth2ScopeTranslationEntry
id: OAuth2ScopeTranslationEntry-xxxxxx
displayName: 
comment: 
properties:
  scopePattern:
  translationKey: