Skip to main content
Version: 2026.0

OAuth2WithAliasConfig

Configuration Object for OAuth2.

Methods​

aliasName​

aliasName(aliasName): OAuth2WithAliasConfig

Sets the alias name that is to be used for authentication.

Parameters​

aliasName
string | number | boolean

the alias name

Returns​

OAuth2WithAliasConfig

OAuth2CertificateConfig


getAliasName​

getAliasName(): string

Returns the alias name.

Returns​

string

the alias name


getScope​

getScope(): string

Returns the scope.

Returns​

string

the scope


scope​

scope(scope): OAuth2WithAliasConfig

Sets the scope. Scope can be a list sperated by a space like in this example: scope=Chat.Read Chat.ReadWrite. If the scope is not set here, the scope from the authentication alias will be used. If no scope should be passed, but there is a scope set in the authentication alias, an empty string (but not null) has to be passed.

Parameters​

scope
string | number | boolean

the scope

Returns​

OAuth2WithAliasConfig

OAuth2CertificateConfig