UpdateOIDCApplicationConfigurationRequest class

Available extensions

Constructors

UpdateOIDCApplicationConfigurationRequest({Iterable<String>? redirectUris, Iterable<OIDCResponseType>? responseTypes, Iterable<OIDCGrantType>? grantTypes, OIDCApplicationType? applicationType, OIDCAuthMethodType? authMethodType, Iterable<String>? postLogoutRedirectUris, OIDCVersion? version, bool? developmentMode, OIDCTokenType? accessTokenType, bool? accessTokenRoleAssertion, bool? idTokenRoleAssertion, bool? idTokenUserinfoAssertion, Duration? clockSkew, Iterable<String>? additionalOrigins, bool? skipNativeAppSuccessPage, String? backChannelLogoutUri, LoginVersion? loginVersion})
factory
UpdateOIDCApplicationConfigurationRequest.fromBuffer(List<int> data, [ExtensionRegistry registry = $pb.ExtensionRegistry.EMPTY])
factory
UpdateOIDCApplicationConfigurationRequest.fromJson(String json, [ExtensionRegistry registry = $pb.ExtensionRegistry.EMPTY])
factory

Properties

accessTokenRoleAssertion ↔ bool
If AccessTokenRoleAssertion is enabled, the roles of the user are added to the access token. Ensure that the access token is a JWT token and not a bearer token. And either request the roles by scope or enable the user role assertion on the project. If not set, the access token role assertion will not be changed.
getter/setter pair
accessTokenType ↔ OIDCTokenType
The AccessTokenType defines the type of the access token returned from ZITADEL. Bearer tokens are opaque to clients. JWT tokens are self-contained and can be validated by the client. Bearer tokens must be introspected at the ZITADEL token endpoint. If not set, the access token type will not be changed.
getter/setter pair
additionalOrigins → PbList<String>
AdditionalOrigins are HTTP origins (scheme + host + port) from where the API can be used additional to the redirect_uris. This is useful if the application is used from an origin different to the redirect_uris, e.g. if the application is a SPA served in a native app, where the redirect_uri is a custom scheme, but the application is served from a https origin. Any existing additional origins not included in this list will be removed. If not set, the additional origins will not be changed.
no setter
applicationType ↔ OIDCApplicationType
ApplicationType defines the OAuth2/OIDC client type and their ability to maintain confidentiality of their credentials. This influences the allowed grant types and the required authentication method. If not set, the application type will not be changed.
getter/setter pair
authMethodType ↔ OIDCAuthMethodType
The authentication method type used by the application to authenticate at the token endpoint. If not set, the authentication method type will not be changed.
getter/setter pair
backChannelLogoutUri ↔ String
BackChannelLogoutURI is used to notify the application about terminated sessions according to the OIDC Back-Channel Logout (https://openid.net/specs/openid-connect-backchannel-1_0.html). If not set, the back channel logout URI will not be changed.
getter/setter pair
clockSkew ↔ Duration
ClockSkew is used to compensate time differences between the servers of ZITADEL and the application. It is added to the "exp" claim and subtracted from "iat", "auth_time" and "nbf" claims. The default is 0s, the maximum is 5s. If not set, the clock skew will not be changed.
getter/setter pair
developmentMode ↔ bool
DevelopmentMode can be enabled for development purposes. This allows the use of OIDC non-compliant and potentially insecure settings, such as the use of HTTP redirect URIs or wildcard redirect URIs. If not set, the dev mode will not be changed.
getter/setter pair
grantTypes → PbList<OIDCGrantType>
GrantTypes define the flow type the application is allowed to use. The grant_type parameter in the token request must exactly match one of these values. Minimum one grant type must be provided, but multiple grant types can be provided to allow different flows, e.g. authorization code flow and refresh token flow. Any existing grant types not included in this list will be removed. If not set, the grant types will not be changed.
no setter
hashCode → int
Calculates a hash code based on the contents of the protobuf.
no setterinherited
idTokenRoleAssertion ↔ bool
If IDTokenRoleAssertion is enabled, the roles of the user are added to the id token. Ensure that either the roles are requested by scope or enable the user role assertion on the project. If not set, the id token role assertion will not be changed.
getter/setter pair
idTokenUserinfoAssertion ↔ bool
If IDTokenUserinfoAssertion is enabled, the claims of profile, email, address and phone scopes are added to the id token even if an access token is issued. This can be required by some applications that do not call the userinfo endpoint after authentication or directly use the id_token for retrieving user information. Attention: this violates the OIDC specification, which states that these claims must only be requested from the userinfo endpoint if an access token is issued. This is to prevent leaking of personal information in the id token, which is often stored in the browser and therefore more vulnerable. If not set, the id token userinfo assertion will not be changed.
getter/setter pair
info_ → BuilderInfo
no setter
isFrozen → bool
Returns true if this message is marked read-only. Otherwise false.
no setterinherited
loginVersion ↔ LoginVersion
LoginVersion specifies the login UI, where the user is redirected to for authentication. It can be used to select a specific login UI, e.g. for embedded UIs or for custom login pages hosted on any other domain. If unset, the login UI is chosen by the instance default.
getter/setter pair
postLogoutRedirectUris → PbList<String>
PostLogoutRedirectURIs are the allowed URIs to redirect to after a logout. The post_logout_redirect_uri parameter in the logout request must exactly match one of these URIs. Any existing post logout redirect URIs not included in this list will be removed. If not set, the post logout redirect URIs will not be changed.
no setter
redirectUris → PbList<String>
RedirectURIs are the allowed callback URIs for the OAuth2 / OIDC flows, where the authorization code or tokens will be sent to. The redirect_uri parameter in the authorization request must exactly match one of these URIs. Any existing redirect URIs not included in this list will be removed. If not set, the redirect URIs will not be changed.
no setter
responseTypes → PbList<OIDCResponseType>
ResponseTypes define whether a code, id_token token or just id_token will be returned. The response_type parameter in the authorization request must exactly match one of these values. Any existing response types not included in this list will be removed. If not set, the response types will not be changed.
no setter
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
skipNativeAppSuccessPage ↔ bool
For native apps a successful login usually shows a success page with a link to open the application again. SkipNativeAppSuccessPage can be used to skip this page and open the application directly. If not set, the skip native app success page will not be changed.
getter/setter pair
unknownFields → UnknownFieldSet
no setterinherited
version ↔ OIDCVersion
Version defines the OIDC version used by the application. Currently, only version 1.0 is supported. Future versions might introduce breaking changes. If not set, the version will not be changed.
getter/setter pair

Methods

addExtension(Extension extension, Object? value) → void
Adds an extension field value to a repeated field.
inherited
check() → void
Throws a StateError if the message has required fields without a value.
inherited
clear() → void
Clears all data that was set in this message.
inherited
clearAccessTokenRoleAssertion() → void
clearAccessTokenType() → void
clearApplicationType() → void
clearAuthMethodType() → void
clearBackChannelLogoutUri() → void
clearClockSkew() → void
clearDevelopmentMode() → void
clearExtension(Extension extension) → void
Clears an extension field and also removes the extension.
inherited
clearField(int tagNumber) → void
Clears the contents of a given field.
inherited
clearIdTokenRoleAssertion() → void
clearIdTokenUserinfoAssertion() → void
clearLoginVersion() → void
clearSkipNativeAppSuccessPage() → void
clearVersion() → void
clone() → UpdateOIDCApplicationConfigurationRequest
Creates a deep copy of the fields in this message.
copyWith(void updates(UpdateOIDCApplicationConfigurationRequest)) → UpdateOIDCApplicationConfigurationRequest
Apply updates to a copy of this message.
createEmptyInstance() → UpdateOIDCApplicationConfigurationRequest
Creates an empty instance of the same message type as this.
deepCopy() → T

Available on T, provided by the GeneratedMessageGenericExtensions extension

Returns a writable deep copy of this message.
ensureClockSkew() → Duration
ensureLoginVersion() → LoginVersion
extensionsAreInitialized() → bool
inherited
freeze() → GeneratedMessage
Make this message read-only.
inherited
getDefaultForField(int tagNumber) → dynamic
Returns the default value for the given field.
inherited
getExtension(Extension extension) → dynamic
Returns the value of extension.
inherited
getField(int tagNumber) → dynamic
Returns the value of the field associated with tagNumber, or the default value if it is not set.
inherited
getFieldOrNull(int tagNumber) → dynamic
Returns the value of a field, ignoring any defaults.
inherited
getTagNumber(String fieldName) → int?
inherited
hasAccessTokenRoleAssertion() → bool
hasAccessTokenType() → bool
hasApplicationType() → bool
hasAuthMethodType() → bool
hasBackChannelLogoutUri() → bool
hasClockSkew() → bool
hasDevelopmentMode() → bool
hasExtension(Extension extension) → bool
Returns true if a value of extension is present.
inherited
hasField(int tagNumber) → bool
Whether this message has a field associated with tagNumber.
inherited
hasIdTokenRoleAssertion() → bool
hasIdTokenUserinfoAssertion() → bool
hasLoginVersion() → bool
hasRequiredFields() → bool
Whether the message has required fields.
inherited
hasSkipNativeAppSuccessPage() → bool
hasVersion() → bool
isInitialized() → bool
Whether all required fields in the message and embedded messages are set.
inherited
mergeFromBuffer(List<int> input, [ExtensionRegistry extensionRegistry = ExtensionRegistry.EMPTY]) → void
Merges serialized protocol buffer data into this message.
inherited
mergeFromCodedBufferReader(CodedBufferReader input, [ExtensionRegistry extensionRegistry = ExtensionRegistry.EMPTY]) → void
Same as mergeFromBuffer, but takes a CodedBufferReader input.
inherited
mergeFromJson(String data, [ExtensionRegistry extensionRegistry = ExtensionRegistry.EMPTY]) → void
Merges field values from data, a JSON object, encoded as described by GeneratedMessage.writeToJson.
inherited
mergeFromJsonMap(Map<String, dynamic> json, [ExtensionRegistry extensionRegistry = ExtensionRegistry.EMPTY]) → void
Merges field values from a JSON object represented as a Dart map.
inherited
mergeFromMessage(GeneratedMessage other) → void
Merges the contents of the other into this message.
inherited
mergeFromProto3Json(Object? json, {TypeRegistry typeRegistry = const TypeRegistry.empty(), bool ignoreUnknownFields = false, bool supportNamesWithUnderscores = true, bool permissiveEnums = false}) → void
Merges field values from json, a JSON object using proto3 encoding.
inherited
mergeUnknownFields(UnknownFieldSet unknownFieldSet) → void
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
rebuild(void updates(T)) → T

Available on T, provided by the GeneratedMessageGenericExtensions extension

Apply updates to a copy of this message.
setExtension(Extension extension, Object value) → void
Sets the value of a non-repeated extension field to value.
inherited
setField(int tagNumber, Object value) → void
Sets the value of a field by its tagNumber.
inherited
toBuilder() → GeneratedMessage
Creates a writable, shallow copy of this message.
inherited
toDebugString() → String
Returns a String representation of this message.
inherited
toProto3Json({TypeRegistry typeRegistry = const TypeRegistry.empty()}) → Object?
Returns an Object representing Proto3 JSON serialization of this.
inherited
toString() → String
Returns a String representation of this message.
inherited
writeToBuffer() → Uint8List
Serialize the message as the protobuf binary format.
inherited
writeToCodedBufferWriter(CodedBufferWriter output) → void
Same as writeToBuffer, but serializes to the given CodedBufferWriter.
inherited
writeToJson() → String
Returns a JSON string that encodes this message.
inherited
writeToJsonMap() → Map<String, dynamic>
Returns the JSON encoding of this message as a Dart Map.
inherited

Operators

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