CreateIdentityBody class abstract

Create Identity Body

Properties:

  • credentials
  • metadataAdmin - Store metadata about the user which is only accessible through admin APIs such as GET /admin/identities/<id>.
  • metadataPublic - Store metadata about the identity which the identity itself can see when calling for example the session endpoint. Do not store sensitive information (e.g. credit score) about the identity in this field.
  • recoveryAddresses - RecoveryAddresses contains all the addresses that can be used to recover an identity. Use this structure to import recovery addresses for an identity. Please keep in mind that the address needs to be represented in the Identity Schema or this field will be overwritten on the next identity update.
  • schemaId - SchemaID is the ID of the JSON Schema to be used for validating the identity's traits.
  • state - State is the identity's state. active StateActive inactive StateInactive
  • traits - Traits represent an identity's traits. The identity is able to create, modify, and delete traits in a self-service manner. The input will always be validated against the JSON Schema defined in schema_url.
  • verifiableAddresses - VerifiableAddresses contains all the addresses that can be verified by the user. Use this structure to import verified addresses for an identity. Please keep in mind that the address needs to be represented in the Identity Schema or this field will be overwritten on the next identity update.
Annotations
  • @BuiltValue()

Constructors

CreateIdentityBody([void updates(CreateIdentityBodyBuilder b)])
factory

Properties

credentials → IdentityWithCredentials?
no setter
hashCode → int
The hash code for this object.
no setterinherited
metadataAdmin → JsonObject?
Store metadata about the user which is only accessible through admin APIs such as GET /admin/identities/<id>.
no setter
metadataPublic → JsonObject?
Store metadata about the identity which the identity itself can see when calling for example the session endpoint. Do not store sensitive information (e.g. credit score) about the identity in this field.
no setter
recoveryAddresses → BuiltList<RecoveryIdentityAddress>?
RecoveryAddresses contains all the addresses that can be used to recover an identity. Use this structure to import recovery addresses for an identity. Please keep in mind that the address needs to be represented in the Identity Schema or this field will be overwritten on the next identity update.
no setter
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
schemaId → String
SchemaID is the ID of the JSON Schema to be used for validating the identity's traits.
no setter
state → CreateIdentityBodyStateEnum?
State is the identity's state. active StateActive inactive StateInactive
no setter
traits → JsonObject
Traits represent an identity's traits. The identity is able to create, modify, and delete traits in a self-service manner. The input will always be validated against the JSON Schema defined in schema_url.
no setter
verifiableAddresses → BuiltList<VerifiableIdentityAddress>?
VerifiableAddresses contains all the addresses that can be verified by the user. Use this structure to import verified addresses for an identity. Please keep in mind that the address needs to be represented in the Identity Schema or this field will be overwritten on the next identity update.
no setter

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
rebuild(dynamic updates(CreateIdentityBodyBuilder)) → CreateIdentityBody
Rebuilds the instance.
inherited
toBuilder() → CreateIdentityBodyBuilder
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<CreateIdentityBody>
no setter