Identity class abstract

An identity represents a (human) user in Ory.

Properties:

  • createdAt - CreatedAt is a helper struct field for gobuffalo.pop.
  • credentials - Credentials represents all credentials that can be used for authenticating this identity.
  • id - ID is the identity's unique identifier. The Identity ID can not be changed and can not be chosen. This ensures future compatibility and optimization for distributed stores such as CockroachDB.
  • metadataAdmin - NullJSONRawMessage represents a json.RawMessage that works well with JSON, SQL, and Swagger and is NULLable-
  • metadataPublic - NullJSONRawMessage represents a json.RawMessage that works well with JSON, SQL, and Swagger and is NULLable-
  • organizationId
  • recoveryAddresses - RecoveryAddresses contains all the addresses that can be used to recover an identity.
  • schemaId - SchemaID is the ID of the JSON Schema to be used for validating the identity's traits.
  • schemaUrl - SchemaURL is the URL of the endpoint where the identity's traits schema can be fetched from. format: url
  • state - State is the identity's state. This value has currently no effect. active StateActive inactive StateInactive
  • stateChangedAt
  • 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.
  • updatedAt - UpdatedAt is a helper struct field for gobuffalo.pop.
  • verifiableAddresses - VerifiableAddresses contains all the addresses that can be verified by the user.
Annotations
  • @BuiltValue()

Constructors

Identity([void updates(IdentityBuilder b)])
factory

Properties

createdAt → DateTime?
CreatedAt is a helper struct field for gobuffalo.pop.
no setter
credentials → BuiltMap<String, IdentityCredentials>?
Credentials represents all credentials that can be used for authenticating this identity.
no setter
hashCode → int
The hash code for this object.
no setterinherited
id → String
ID is the identity's unique identifier. The Identity ID can not be changed and can not be chosen. This ensures future compatibility and optimization for distributed stores such as CockroachDB.
no setter
metadataAdmin → JsonObject?
NullJSONRawMessage represents a json.RawMessage that works well with JSON, SQL, and Swagger and is NULLable-
no setter
metadataPublic → JsonObject?
NullJSONRawMessage represents a json.RawMessage that works well with JSON, SQL, and Swagger and is NULLable-
no setter
organizationId → String?
no setter
recoveryAddresses → BuiltList<RecoveryIdentityAddress>?
RecoveryAddresses contains all the addresses that can be used to recover an identity.
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
schemaUrl → String
SchemaURL is the URL of the endpoint where the identity's traits schema can be fetched from. format: url
no setter
state → IdentityStateEnum?
State is the identity's state. This value has currently no effect. active StateActive inactive StateInactive
no setter
stateChangedAt → DateTime?
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
updatedAt → DateTime?
UpdatedAt is a helper struct field for gobuffalo.pop.
no setter
verifiableAddresses → BuiltList<VerifiableIdentityAddress>?
VerifiableAddresses contains all the addresses that can be verified by the user.
no setter

Methods

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