@leancodepl/kratos

/** * Ory APIs * # Introduction Documentation for all public and administrative Ory APIs. Administrative APIs can only be accessed with a valid Personal Access Token. Public APIs are mostly used in browsers. ## SDKs This document describes the APIs available in the Ory Network. The APIs are available as SDKs for the following languages: | Language | Download SDK | Documentation | | -------------- | ---------------------------------------------------------------- | ------------------------------------------------------------------------------------ | | Dart | [pub.dev](https://pub.dev/packages/ory_client) | [README](https://github.com/ory/sdk/blob/master/clients/client/dart/README.md) | | .NET | [nuget.org](https://www.nuget.org/packages/Ory.Client/) | [README](https://github.com/ory/sdk/blob/master/clients/client/dotnet/README.md) | | Elixir | [hex.pm](https://hex.pm/packages/ory_client) | [README](https://github.com/ory/sdk/blob/master/clients/client/elixir/README.md) | | Go | [github.com](https://github.com/ory/client-go) | [README](https://github.com/ory/sdk/blob/master/clients/client/go/README.md) | | Java | [maven.org](https://search.maven.org/artifact/sh.ory/ory-client) | [README](https://github.com/ory/sdk/blob/master/clients/client/java/README.md) | | JavaScript | [npmjs.com](https://www.npmjs.com/package/@ory/client) | [README](https://github.com/ory/sdk/blob/master/clients/client/typescript/README.md) | | JavaScript (With fetch) | [npmjs.com](https://www.npmjs.com/package/@ory/client-fetch) | [README](https://github.com/ory/sdk/blob/master/clients/client/typescript-fetch/README.md) | | PHP | [packagist.org](https://packagist.org/packages/ory/client) | [README](https://github.com/ory/sdk/blob/master/clients/client/php/README.md) | | Python | [pypi.org](https://pypi.org/project/ory-client/) | [README](https://github.com/ory/sdk/blob/master/clients/client/python/README.md) | | Ruby | [rubygems.org](https://rubygems.org/gems/ory-client) | [README](https://github.com/ory/sdk/blob/master/clients/client/ruby/README.md) | | Rust | [crates.io](https://crates.io/crates/ory-client) | [README](https://github.com/ory/sdk/blob/master/clients/client/rust/README.md) | * * The version of the OpenAPI document: v1.20.10 * Contact: support@ory.sh * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ import type { VerifiableIdentityAddress } from './VerifiableIdentityAddress'; import type { RecoveryIdentityAddress } from './RecoveryIdentityAddress'; import type { IdentityCredentials } from './IdentityCredentials'; /** * An [identity](https://www.ory.sh/docs/kratos/concepts/identity-user-model) represents a (human) user in Ory. * @export * @interface Identity */ export interface Identity { /** * CreatedAt is a helper struct field for gobuffalo.pop. * @type {Date} * @memberof Identity */ created_at?: Date; /** * Credentials represents all credentials that can be used for authenticating this identity. * @type {{ [key: string]: IdentityCredentials; }} * @memberof Identity */ credentials?: { [key: string]: IdentityCredentials; }; /** * 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. * @type {string} * @memberof Identity */ id: string; /** * NullJSONRawMessage represents a json.RawMessage that works well with JSON, SQL, and Swagger and is NULLable- * @type {object} * @memberof Identity */ metadata_admin?: object | null; /** * NullJSONRawMessage represents a json.RawMessage that works well with JSON, SQL, and Swagger and is NULLable- * @type {object} * @memberof Identity */ metadata_public?: object | null; /** * * @type {string} * @memberof Identity */ organization_id?: string | null; /** * RecoveryAddresses contains all the addresses that can be used to recover an identity. * @type {Array<RecoveryIdentityAddress>} * @memberof Identity */ recovery_addresses?: Array<RecoveryIdentityAddress>; /** * SchemaID is the ID of the JSON Schema to be used for validating the identity's traits. * @type {string} * @memberof Identity */ schema_id: string; /** * SchemaURL is the URL of the endpoint where the identity's traits schema can be fetched from. * * format: url * @type {string} * @memberof Identity */ schema_url: string; /** * State is the identity's state. * * This value has currently no effect. * active StateActive * inactive StateInactive * @type {string} * @memberof Identity */ state?: IdentityStateEnum; /** * * @type {Date} * @memberof Identity */ state_changed_at?: Date; /** * 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`. * @type {any} * @memberof Identity */ traits: any | null; /** * UpdatedAt is a helper struct field for gobuffalo.pop. * @type {Date} * @memberof Identity */ updated_at?: Date; /** * VerifiableAddresses contains all the addresses that can be verified by the user. * @type {Array<VerifiableIdentityAddress>} * @memberof Identity */ verifiable_addresses?: Array<VerifiableIdentityAddress>; } /** * @export */ export declare const IdentityStateEnum: { readonly Active: "active"; readonly Inactive: "inactive"; readonly UnknownDefaultOpenApi: "11184809"; }; export type IdentityStateEnum = typeof IdentityStateEnum[keyof typeof IdentityStateEnum]; /** * Check if a given object implements the Identity interface. */ export declare function instanceOfIdentity(value: object): value is Identity; export declare function IdentityFromJSON(json: any): Identity; export declare function IdentityFromJSONTyped(json: any, ignoreDiscriminator: boolean): Identity; export declare function IdentityToJSON(json: any): Identity; export declare function IdentityToJSONTyped(value?: Identity | null, ignoreDiscriminator?: boolean): any;