OAuth2Client class abstract

OAuth2Client

Properties:

  • id
  • createdTime - Entity creation timestamp in milliseconds since Unix epoch
  • additionalInfo - Additional info of OAuth2 client. Must include: 'providerName' (string, name of the OAuth2 provider).
  • tenantId - JSON object with Tenant Id
  • customerId - JSON object with Customer Id
  • title - Oauth2 client title
  • mapperConfig - Config for mapping OAuth2 log in response to platform entities
  • clientId - OAuth2 client ID. Cannot be empty
  • clientSecret - OAuth2 client secret. Cannot be empty
  • authorizationUri - Authorization URI of the OAuth2 provider. Cannot be empty
  • accessTokenUri - Access token URI of the OAuth2 provider. Cannot be empty
  • scope - OAuth scopes that will be requested from OAuth2 platform. Cannot be empty
  • userInfoUri - User info URI of the OAuth2 provider
  • userNameAttributeName - Name of the username attribute in OAuth2 provider response. Cannot be empty
  • jwkSetUri - JSON Web Key URI of the OAuth2 provider
  • clientAuthenticationMethod - Client authentication method to use: 'BASIC' or 'POST'. Cannot be empty
  • loginButtonLabel - OAuth2 provider label. Cannot be empty
  • loginButtonIcon - Log in button icon for OAuth2 provider
  • platforms - List of platforms for which usage of the OAuth2 client is allowed (empty for all allowed)
  • name
  • ownerId
Annotations
  • @BuiltValue.new()

Constructors

OAuth2Client([void updates(OAuth2ClientBuilder b)])
factory

Properties

accessTokenUri → String
Access token URI of the OAuth2 provider. Cannot be empty
no setter
additionalInfo → JsonObject?
Additional info of OAuth2 client. Must include: 'providerName' (string, name of the OAuth2 provider).
no setter
authorizationUri → String
Authorization URI of the OAuth2 provider. Cannot be empty
no setter
clientAuthenticationMethod → String
Client authentication method to use: 'BASIC' or 'POST'. Cannot be empty
no setter
clientId → String
OAuth2 client ID. Cannot be empty
no setter
clientSecret → String
OAuth2 client secret. Cannot be empty
no setter
createdTime → int?
Entity creation timestamp in milliseconds since Unix epoch
no setter
customerId → CustomerId?
JSON object with Customer Id
no setter
hashCode → int
The hash code for this object.
no setterinherited
id → OAuth2ClientId?
no setter
jwkSetUri → String?
JSON Web Key URI of the OAuth2 provider
no setter
loginButtonIcon → String?
Log in button icon for OAuth2 provider
no setter
loginButtonLabel → String
OAuth2 provider label. Cannot be empty
no setter
mapperConfig → OAuth2MapperConfig
Config for mapping OAuth2 log in response to platform entities
no setter
name → String?
no setter
ownerId → EntityId?
no setter
platforms → BuiltList<PlatformType>?
List of platforms for which usage of the OAuth2 client is allowed (empty for all allowed)
no setter
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
scope → BuiltList<String>
OAuth scopes that will be requested from OAuth2 platform. Cannot be empty
no setter
tenantId → TenantId?
JSON object with Tenant Id
no setter
title → String
Oauth2 client title
no setter
userInfoUri → String?
User info URI of the OAuth2 provider
no setter
userNameAttributeName → String
Name of the username attribute in OAuth2 provider response. Cannot be empty
no setter

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
rebuild(dynamic updates(OAuth2ClientBuilder)) → OAuth2Client
Rebuilds the instance.
inherited
toBuilder() → OAuth2ClientBuilder
Converts the instance to a builder B.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Static Properties

serializer → Serializer<OAuth2Client>
no setter