@leancodepl/kratos
Version:
Headless React components library for building Ory Kratos authentication flows
135 lines (134 loc) • 7 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.
*/
/**
*
* @export
* @interface NormalizedProjectRevisionHook
*/
export interface NormalizedProjectRevisionHook {
/**
* The Hooks Config Key
* @type {string}
* @memberof NormalizedProjectRevisionHook
*/
config_key: string;
/**
* The Project's Revision Creation Date
* @type {Date}
* @memberof NormalizedProjectRevisionHook
*/
readonly created_at?: Date;
/**
* The Hook Type
* @type {string}
* @memberof NormalizedProjectRevisionHook
*/
hook: string;
/**
* ID of the entry
* @type {string}
* @memberof NormalizedProjectRevisionHook
*/
id?: string;
/**
* The Revision's ID this schema belongs to
* @type {string}
* @memberof NormalizedProjectRevisionHook
*/
project_revision_id?: string;
/**
* Last Time Project's Revision was Updated
* @type {Date}
* @memberof NormalizedProjectRevisionHook
*/
readonly updated_at?: Date;
/**
* Whether to send the API Key in the HTTP Header or as a HTTP Cookie
* @type {string}
* @memberof NormalizedProjectRevisionHook
*/
web_hook_config_auth_api_key_in?: string;
/**
* The name of the api key
* @type {string}
* @memberof NormalizedProjectRevisionHook
*/
web_hook_config_auth_api_key_name?: string;
/**
* The value of the api key
* @type {string}
* @memberof NormalizedProjectRevisionHook
*/
web_hook_config_auth_api_key_value?: string;
/**
* The password to be sent in the HTTP Basic Auth Header
* @type {string}
* @memberof NormalizedProjectRevisionHook
*/
web_hook_config_auth_basic_auth_password?: string;
/**
* The username to be sent in the HTTP Basic Auth Header
* @type {string}
* @memberof NormalizedProjectRevisionHook
*/
web_hook_config_auth_basic_auth_user?: string;
/**
* HTTP Auth Method to use for the Web-Hook
* @type {string}
* @memberof NormalizedProjectRevisionHook
*/
web_hook_config_auth_type?: string;
/**
* URI pointing to the JsonNet template used for Web-Hook payload generation. Only used for those HTTP methods, which support HTTP body payloads.
* @type {string}
* @memberof NormalizedProjectRevisionHook
*/
web_hook_config_body?: string;
/**
* If enabled allows the web hook to interrupt / abort the self-service flow. It only applies to certain flows (registration/verification/login/settings) and requires a valid response format.
* @type {boolean}
* @memberof NormalizedProjectRevisionHook
*/
web_hook_config_can_interrupt?: boolean;
/**
* The HTTP method to use (GET, POST, etc) for the Web-Hook
* @type {string}
* @memberof NormalizedProjectRevisionHook
*/
web_hook_config_method?: string;
/**
* Whether to ignore the Web Hook response
* @type {boolean}
* @memberof NormalizedProjectRevisionHook
*/
web_hook_config_response_ignore?: boolean;
/**
* Whether to parse the Web Hook response
* @type {boolean}
* @memberof NormalizedProjectRevisionHook
*/
web_hook_config_response_parse?: boolean;
/**
* The URL the Web-Hook should call
* @type {string}
* @memberof NormalizedProjectRevisionHook
*/
web_hook_config_url?: string;
}
/**
* Check if a given object implements the NormalizedProjectRevisionHook interface.
*/
export declare function instanceOfNormalizedProjectRevisionHook(value: object): value is NormalizedProjectRevisionHook;
export declare function NormalizedProjectRevisionHookFromJSON(json: any): NormalizedProjectRevisionHook;
export declare function NormalizedProjectRevisionHookFromJSONTyped(json: any, ignoreDiscriminator: boolean): NormalizedProjectRevisionHook;
export declare function NormalizedProjectRevisionHookToJSON(json: any): NormalizedProjectRevisionHook;
export declare function NormalizedProjectRevisionHookToJSONTyped(value?: Omit<NormalizedProjectRevisionHook, 'created_at' | 'updated_at'> | null, ignoreDiscriminator?: boolean): any;