AuthenticationOptions class

Options for the authentication of a ServiceAccount. Define specific access options like ZITADEL API access or additional scopes that should be attached to the returned access token.

Constructors

AuthenticationOptions({String? discoveryEndpoint, bool apiAccess = false, List<String>? roles, List<String>? projectAudiences, List<String>? additionalScopes})

Properties

additionalScopes → List<String>

List of arbitrary additional scopes that are concatenated into the scope.

final

apiAccess → bool

Whether the requested access token from ZITADEL will include the "ZITADEL API" project in its audience. The returned token will be able to access the API on the service accounts behalf. Essentially, this attaches the apiAccessScope to the token.

final

discoveryEndpoint → String?

The URL to use as discovery endpoint. This overwrites the default which is the audience plus the well known path (/.well-known/openid-configuration).

final

hashCode → int

The hash code for this object.

no setter, inherited

projectAudiences → List<String>

List of audiences that should be attached to the token. Translates to the additional audience scope (urn:zitadel:iam:org:project:id:{ProjectId}:aud).

final

roles → List<String>

A list of required roles to add to the fetched token. Translates to the role scope (urn:zitadel:iam:org:project:role:{Role}).

final

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

createScopes() → String

Create the OIDC scopes for this options instance. Used to request a token from ZITADEL.

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited