@leancodepl/kratos
Version:
Headless React components library for building Ory Kratos authentication flows
92 lines (91 loc) • 5.8 kB
TypeScript
/**
* 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.
*/
/**
* Credentials represents a specific credential type
* @export
* @interface IdentityCredentials
*/
export interface IdentityCredentials {
/**
*
* @type {object}
* @memberof IdentityCredentials
*/
config?: object;
/**
* CreatedAt is a helper struct field for gobuffalo.pop.
* @type {Date}
* @memberof IdentityCredentials
*/
created_at?: Date;
/**
* Identifiers represents a list of unique identifiers this credential type matches.
* @type {Array<string>}
* @memberof IdentityCredentials
*/
identifiers?: Array<string>;
/**
* Type discriminates between different types of credentials.
* password CredentialsTypePassword
* oidc CredentialsTypeOIDC
* totp CredentialsTypeTOTP
* lookup_secret CredentialsTypeLookup
* webauthn CredentialsTypeWebAuthn
* code CredentialsTypeCodeAuth
* passkey CredentialsTypePasskey
* profile CredentialsTypeProfile
* saml CredentialsTypeSAML
* link_recovery CredentialsTypeRecoveryLink CredentialsTypeRecoveryLink is a special credential type linked to the link strategy (recovery flow). It is not used within the credentials object itself.
* code_recovery CredentialsTypeRecoveryCode
* @type {string}
* @memberof IdentityCredentials
*/
type?: IdentityCredentialsTypeEnum;
/**
* UpdatedAt is a helper struct field for gobuffalo.pop.
* @type {Date}
* @memberof IdentityCredentials
*/
updated_at?: Date;
/**
* Version refers to the version of the credential. Useful when changing the config schema.
* @type {number}
* @memberof IdentityCredentials
*/
version?: number;
}
/**
* @export
*/
export declare const IdentityCredentialsTypeEnum: {
readonly Password: "password";
readonly Oidc: "oidc";
readonly Totp: "totp";
readonly LookupSecret: "lookup_secret";
readonly Webauthn: "webauthn";
readonly Code: "code";
readonly Passkey: "passkey";
readonly Profile: "profile";
readonly Saml: "saml";
readonly LinkRecovery: "link_recovery";
readonly CodeRecovery: "code_recovery";
readonly UnknownDefaultOpenApi: "11184809";
};
export type IdentityCredentialsTypeEnum = typeof IdentityCredentialsTypeEnum[keyof typeof IdentityCredentialsTypeEnum];
/**
* Check if a given object implements the IdentityCredentials interface.
*/
export declare function instanceOfIdentityCredentials(value: object): value is IdentityCredentials;
export declare function IdentityCredentialsFromJSON(json: any): IdentityCredentials;
export declare function IdentityCredentialsFromJSONTyped(json: any, ignoreDiscriminator: boolean): IdentityCredentials;
export declare function IdentityCredentialsToJSON(json: any): IdentityCredentials;
export declare function IdentityCredentialsToJSONTyped(value?: IdentityCredentials | null, ignoreDiscriminator?: boolean): any;