AddSAMLProviderRequest class

Available extensions

Constructors

AddSAMLProviderRequest({String? name, List<int>? metadataXml, String? metadataUrl, SAMLBinding? binding, bool? withSignedRequest, Options? providerOptions, SAMLNameIDFormat? nameIdFormat, String? transientMappingAttributeName, bool? federatedLogoutEnabled, SAMLSignatureAlgorithm? signatureAlgorithm})
factory
AddSAMLProviderRequest.fromBuffer(List<int> data, [ExtensionRegistry registry = $pb.ExtensionRegistry.EMPTY])
factory
AddSAMLProviderRequest.fromJson(String json, [ExtensionRegistry registry = $pb.ExtensionRegistry.EMPTY])
factory

Properties

binding SAMLBinding
Binding which defines the type of communication with the identity provider.
getter/setter pair
federatedLogoutEnabled bool
Optionally enable federated logout. If enabled, ZITADEL will send a logout request to the identity provider, if the user terminates the session in ZITADEL. Be sure to provide a SLO endpoint as part of the metadata.
getter/setter pair
hashCode int
Calculates a hash code based on the contents of the protobuf.
no setterinherited
info_ → BuilderInfo
no setter
isFrozen bool
Returns true if this message is marked read-only. Otherwise false.
no setterinherited
metadataUrl String
Url to the metadata of the SAML identity provider.
getter/setter pair
metadataXml List<int>
Metadata of the SAML identity provider.
getter/setter pair
name String
getter/setter pair
nameIdFormat SAMLNameIDFormat
Optionally specify the nameid-format requested.
getter/setter pair
providerOptions Options
getter/setter pair
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
signatureAlgorithm SAMLSignatureAlgorithm
Specify a Signature Algorithm that should be used to sign SAML requests and responses. Can be used only if the with_signed_request option is set to true.
getter/setter pair
transientMappingAttributeName String
Optionally specify the name of the attribute, which will be used to map the user in case the nameid-format returned is urn:oasis:names:tc:SAML:2.0:nameid-format:transient.
getter/setter pair
unknownFields → UnknownFieldSet
no setterinherited
withSignedRequest bool
Boolean which defines if the authentication requests are signed.
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
clearBinding() → void
clearExtension(Extension extension) → void
Clears an extension field and also removes the extension.
inherited
clearFederatedLogoutEnabled() → void
clearField(int tagNumber) → void
Clears the contents of a given field.
inherited
clearMetadata() → void
clearMetadataUrl() → void
clearMetadataXml() → void
clearName() → void
clearNameIdFormat() → void
clearProviderOptions() → void
clearSignatureAlgorithm() → void
clearTransientMappingAttributeName() → void
clearWithSignedRequest() → void
clone() AddSAMLProviderRequest
Creates a deep copy of the fields in this message.
copyWith(void updates(AddSAMLProviderRequest)) AddSAMLProviderRequest
Apply updates to a copy of this message.
createEmptyInstance() AddSAMLProviderRequest
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.
ensureProviderOptions() Options
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
hasBinding() bool
hasExtension(Extension extension) bool
Returns true if a value of extension is present.
inherited
hasFederatedLogoutEnabled() bool
hasField(int tagNumber) bool
Whether this message has a field associated with tagNumber.
inherited
hasMetadataUrl() bool
hasMetadataXml() bool
hasName() bool
hasNameIdFormat() bool
hasProviderOptions() bool
hasRequiredFields() bool
Whether the message has required fields.
inherited
hasSignatureAlgorithm() bool
hasTransientMappingAttributeName() bool
hasWithSignedRequest() 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
whichMetadata() AddSAMLProviderRequest_Metadata
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