@leancodepl/kratos/dist/lib/kratos/api.generated/models/UpdateIdentityBody.d.ts

Headless React components library for building Ory Kratos authentication flows

import { IdentityWithCredentials } from './IdentityWithCredentials';
/**
 * Update Identity Body
 * @export
 * @interface UpdateIdentityBody
 */
export interface UpdateIdentityBody {
    /**
     *
     * @type {IdentityWithCredentials}
     * @memberof UpdateIdentityBody
     */
    credentials?: IdentityWithCredentials;
    /**
     * Store metadata about the user which is only accessible through admin APIs such as `GET /admin/identities/<id>`.
     * @type {any}
     * @memberof UpdateIdentityBody
     */
    metadata_admin?: any | null;
    /**
     * 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.
     * @type {any}
     * @memberof UpdateIdentityBody
     */
    metadata_public?: any | null;
    /**
     * SchemaID is the ID of the JSON Schema to be used for validating the identity's traits. If set
     * will update the Identity's SchemaID.
     * @type {string}
     * @memberof UpdateIdentityBody
     */
    schema_id: string;
    /**
     * State is the identity's state.
     * active StateActive
     * inactive StateInactive
     * @type {string}
     * @memberof UpdateIdentityBody
     */
    state: UpdateIdentityBodyStateEnum;
    /**
     * 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_id`.
     * @type {object}
     * @memberof UpdateIdentityBody
     */
    traits: object;
}
/**
 * @export
 */
export declare const UpdateIdentityBodyStateEnum: {
    readonly Active: "active";
    readonly Inactive: "inactive";
    readonly UnknownDefaultOpenApi: "11184809";
};
export type UpdateIdentityBodyStateEnum = typeof UpdateIdentityBodyStateEnum[keyof typeof UpdateIdentityBodyStateEnum];
/**
 * Check if a given object implements the UpdateIdentityBody interface.
 */
export declare function instanceOfUpdateIdentityBody(value: object): value is UpdateIdentityBody;
export declare function UpdateIdentityBodyFromJSON(json: any): UpdateIdentityBody;
export declare function UpdateIdentityBodyFromJSONTyped(json: any, ignoreDiscriminator: boolean): UpdateIdentityBody;
export declare function UpdateIdentityBodyToJSON(json: any): UpdateIdentityBody;
export declare function UpdateIdentityBodyToJSONTyped(value?: UpdateIdentityBody | null, ignoreDiscriminator?: boolean): any;
//# sourceMappingURL=UpdateIdentityBody.d.ts.map