@ory/client

/** * 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.22.22 * 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 { Configuration } from './configuration'; import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios'; import type { RequestArgs } from './base'; import { BaseAPI } from './base'; /** * Contains information on an device verification * @export * @interface AcceptDeviceUserCodeRequest */ export interface AcceptDeviceUserCodeRequest { /** * * @type {string} * @memberof AcceptDeviceUserCodeRequest */ 'user_code'?: string; } /** * * @export * @interface AcceptOAuth2ConsentRequest */ export interface AcceptOAuth2ConsentRequest { /** * * @type {object} * @memberof AcceptOAuth2ConsentRequest */ 'context'?: object; /** * * @type {Array<string>} * @memberof AcceptOAuth2ConsentRequest */ 'grant_access_token_audience'?: Array<string>; /** * * @type {Array<string>} * @memberof AcceptOAuth2ConsentRequest */ 'grant_scope'?: Array<string>; /** * Remember, if set to true, tells ORY Hydra to remember this consent authorization and reuse it if the same client asks the same user for the same, or a subset of, scope. * @type {boolean} * @memberof AcceptOAuth2ConsentRequest */ 'remember'?: boolean; /** * RememberFor sets how long the consent authorization should be remembered for in seconds. If set to `0`, the authorization will be remembered indefinitely. * @type {number} * @memberof AcceptOAuth2ConsentRequest */ 'remember_for'?: number; /** * * @type {AcceptOAuth2ConsentRequestSession} * @memberof AcceptOAuth2ConsentRequest */ 'session'?: AcceptOAuth2ConsentRequestSession; } /** * * @export * @interface AcceptOAuth2ConsentRequestSession */ export interface AcceptOAuth2ConsentRequestSession { /** * AccessToken sets session data for the access and refresh token, as well as any future tokens issued by the refresh grant. Keep in mind that this data will be available to anyone performing OAuth 2.0 Challenge Introspection. If only your services can perform OAuth 2.0 Challenge Introspection, this is usually fine. But if third parties can access that endpoint as well, sensitive data from the session might be exposed to them. Use with care! * @type {any} * @memberof AcceptOAuth2ConsentRequestSession */ 'access_token'?: any; /** * IDToken sets session data for the OpenID Connect ID token. Keep in mind that the session\'id payloads are readable by anyone that has access to the ID Challenge. Use with care! * @type {any} * @memberof AcceptOAuth2ConsentRequestSession */ 'id_token'?: any; } /** * * @export * @interface AcceptOAuth2LoginRequest */ export interface AcceptOAuth2LoginRequest { /** * ACR sets the Authentication AuthorizationContext Class Reference value for this authentication session. You can use it to express that, for example, a user authenticated using two-factor authentication. * @type {string} * @memberof AcceptOAuth2LoginRequest */ 'acr'?: string; /** * * @type {Array<string>} * @memberof AcceptOAuth2LoginRequest */ 'amr'?: Array<string>; /** * * @type {object} * @memberof AcceptOAuth2LoginRequest */ 'context'?: object; /** * Extend OAuth2 authentication session lifespan If set to `true`, the OAuth2 authentication cookie lifespan is extended. This is for example useful if you want the user to be able to use `prompt=none` continuously. This value can only be set to `true` if the user has an authentication, which is the case if the `skip` value is `true`. * @type {boolean} * @memberof AcceptOAuth2LoginRequest */ 'extend_session_lifespan'?: boolean; /** * ForceSubjectIdentifier forces the \"pairwise\" user ID of the end-user that authenticated. The \"pairwise\" user ID refers to the (Pairwise Identifier Algorithm)[http://openid.net/specs/openid-connect-core-1_0.html#PairwiseAlg] of the OpenID Connect specification. It allows you to set an obfuscated subject (\"user\") identifier that is unique to the client. Please note that this changes the user ID on endpoint /userinfo and sub claim of the ID Token. It does not change the sub claim in the OAuth 2.0 Introspection. Per default, ORY Hydra handles this value with its own algorithm. In case you want to set this yourself you can use this field. Please note that setting this field has no effect if `pairwise` is not configured in ORY Hydra or the OAuth 2.0 Client does not expect a pairwise identifier (set via `subject_type` key in the client\'s configuration). Please also be aware that ORY Hydra is unable to properly compute this value during authentication. This implies that you have to compute this value on every authentication process (probably depending on the client ID or some other unique value). If you fail to compute the proper value, then authentication processes which have id_token_hint set might fail. * @type {string} * @memberof AcceptOAuth2LoginRequest */ 'force_subject_identifier'?: string; /** * IdentityProviderSessionID is the session ID of the end-user that authenticated. If specified, we will use this value to propagate the logout. * @type {string} * @memberof AcceptOAuth2LoginRequest */ 'identity_provider_session_id'?: string; /** * Remember, if set to true, tells Ory Hydra to remember this user by telling the user agent (browser) to store a cookie with authentication data. If the same user performs another OAuth 2.0 Authorization Request, they will not be asked to log in again. * @type {boolean} * @memberof AcceptOAuth2LoginRequest */ 'remember'?: boolean; /** * RememberFor sets how long the authentication should be remembered for in seconds. If set to `0`, the authorization will be remembered for the duration of the browser session (using a session cookie). * @type {number} * @memberof AcceptOAuth2LoginRequest */ 'remember_for'?: number; /** * Subject is the user ID of the end-user that authenticated. * @type {string} * @memberof AcceptOAuth2LoginRequest */ 'subject': string; } /** * * @export * @interface AccountExperienceColors */ export interface AccountExperienceColors { /** * * @type {string} * @memberof AccountExperienceColors */ 'ax_background_default'?: string; /** * * @type {string} * @memberof AccountExperienceColors */ 'brand_100'?: string; /** * * @type {string} * @memberof AccountExperienceColors */ 'brand_200'?: string; /** * * @type {string} * @memberof AccountExperienceColors */ 'brand_300'?: string; /** * * @type {string} * @memberof AccountExperienceColors */ 'brand_400'?: string; /** * * @type {string} * @memberof AccountExperienceColors */ 'brand_50'?: string; /** * * @type {string} * @memberof AccountExperienceColors */ 'brand_500'?: string; /** * * @type {string} * @memberof AccountExperienceColors */ 'brand_600'?: string; /** * * @type {string} * @memberof AccountExperienceColors */ 'brand_700'?: string; /** * * @type {string} * @memberof AccountExperienceColors */ 'brand_800'?: string; /** * * @type {string} * @memberof AccountExperienceColors */ 'brand_900'?: string; /** * * @type {string} * @memberof AccountExperienceColors */ 'brand_950'?: string; /** * * @type {string} * @memberof AccountExperienceColors */ 'button_identifier_background_default'?: string; /** * * @type {string} * @memberof AccountExperienceColors */ 'button_identifier_background_hover'?: string; /** * * @type {string} * @memberof AccountExperienceColors */ 'button_identifier_border_border_default'?: string; /** * * @type {string} * @memberof AccountExperienceColors */ 'button_identifier_border_border_hover'?: string; /** * * @type {string} * @memberof AccountExperienceColors */ 'button_identifier_foreground_default'?: string; /** * * @type {string} * @memberof AccountExperienceColors */ 'button_identifier_foreground_hover'?: string; /** * * @type {string} * @memberof AccountExperienceColors */ 'button_link_brand_brand'?: string; /** * * @type {string} * @memberof AccountExperienceColors */ 'button_link_brand_brand_hover'?: string; /** * * @type {string} * @memberof AccountExperienceColors */ 'button_link_default_primary'?: string; /** * * @type {string} * @memberof AccountExperienceColors */ 'button_link_default_primary_hover'?: string; /** * * @type {string} * @memberof AccountExperienceColors */ 'button_link_default_secondary'?: string; /** * * @type {string} * @memberof AccountExperienceColors */ 'button_link_default_secondary_hover'?: string; /** * * @type {string} * @memberof AccountExperienceColors */ 'button_link_disabled_disabled'?: string; /** * * @type {string} * @memberof AccountExperienceColors */ 'button_primary_background_default'?: string; /** * * @type {string} * @memberof AccountExperienceColors */ 'button_primary_background_disabled'?: string; /** * * @type {string} * @memberof AccountExperienceColors */ 'button_primary_background_hover'?: string; /** * * @type {string} * @memberof AccountExperienceColors */ 'button_primary_border_default'?: string; /** * * @type {string} * @memberof AccountExperienceColors */ 'button_primary_border_disabled'?: string; /** * * @type {string} * @memberof AccountExperienceColors */ 'button_primary_border_hover'?: string; /** * * @type {string} * @memberof AccountExperienceColors */ 'button_primary_foreground_default'?: string; /** * * @type {string} * @memberof AccountExperienceColors */ 'button_primary_foreground_disabled'?: string; /** * * @type {string} * @memberof AccountExperienceColors */ 'button_primary_foreground_hover'?: string; /** * * @type {string} * @memberof AccountExperienceColors */ 'button_secondary_background_default'?: string; /** * * @type {string} * @memberof AccountExperienceColors */ 'button_secondary_background_disabled'?: string; /** * * @type {string} * @memberof AccountExperienceColors */ 'button_secondary_background_hover'?: string; /** * * @type {string} * @memberof AccountExperienceColors */ 'button_secondary_border_default'?: string; /** * * @type {string} * @memberof AccountExperienceColors */ 'button_secondary_border_disabled'?: string; /** * * @type {string} * @memberof AccountExperienceColors */ 'button_secondary_border_hover'?: string; /** * * @type {string} * @memberof AccountExperienceColors */ 'button_secondary_foreground_default'?: string; /** * * @type {string} * @memberof AccountExperienceColors */ 'button_secondary_foreground_disabled'?: string; /** * * @type {string} * @memberof AccountExperienceColors */ 'button_secondary_foreground_hover'?: string; /** * * @type {string} * @memberof AccountExperienceColors */ 'button_social_background_default'?: string; /** * * @type {string} * @memberof AccountExperienceColors */ 'button_social_background_disabled'?: string; /** * * @type {string} * @memberof AccountExperienceColors */ 'button_social_background_generic_provider'?: string; /** * * @type {string} * @memberof AccountExperienceColors */ 'button_social_background_hover'?: string; /** * * @type {string} * @memberof AccountExperienceColors */ 'button_social_border_default'?: string; /** * * @type {string} * @memberof AccountExperienceColors */ 'button_social_border_disabled'?: string; /** * * @type {string} * @memberof AccountExperienceColors */ 'button_social_border_generic_provider'?: string; /** * * @type {string} * @memberof AccountExperienceColors */ 'button_social_border_hover'?: string; /** * * @type {string} * @memberof AccountExperienceColors */ 'button_social_foreground_default'?: string; /** * * @type {string} * @memberof AccountExperienceColors */ 'button_social_foreground_disabled'?: string; /** * * @type {string} * @memberof AccountExperienceColors */ 'button_social_foreground_generic_provider'?: string; /** * * @type {string} * @memberof AccountExperienceColors */ 'button_social_foreground_hover'?: string; /** * * @type {string} * @memberof AccountExperienceColors */ 'checkbox_background_checked'?: string; /** * * @type {string} * @memberof AccountExperienceColors */ 'checkbox_background_default'?: string; /** * * @type {string} * @memberof AccountExperienceColors */ 'checkbox_border_checkbox_border_checked'?: string; /** * * @type {string} * @memberof AccountExperienceColors */ 'checkbox_border_checkbox_border_default'?: string; /** * * @type {string} * @memberof AccountExperienceColors */ 'checkbox_foreground_checked'?: string; /** * * @type {string} * @memberof AccountExperienceColors */ 'checkbox_foreground_default'?: string; /** * * @type {string} * @memberof AccountExperienceColors */ 'form_background_default'?: string; /** * * @type {string} * @memberof AccountExperienceColors */ 'form_border_default'?: string; /** * * @type {string} * @memberof AccountExperienceColors */ 'input_background_default'?: string; /** * * @type {string} * @memberof AccountExperienceColors */ 'input_background_disabled'?: string; /** * * @type {string} * @memberof AccountExperienceColors */ 'input_background_hover'?: string; /** * * @type {string} * @memberof AccountExperienceColors */ 'input_border_default'?: string; /** * * @type {string} * @memberof AccountExperienceColors */ 'input_border_disabled'?: string; /** * * @type {string} * @memberof AccountExperienceColors */ 'input_border_focus'?: string; /** * * @type {string} * @memberof AccountExperienceColors */ 'input_border_hover'?: string; /** * * @type {string} * @memberof AccountExperienceColors */ 'input_foreground_disabled'?: string; /** * * @type {string} * @memberof AccountExperienceColors */ 'input_foreground_primary'?: string; /** * * @type {string} * @memberof AccountExperienceColors */ 'input_foreground_secondary'?: string; /** * * @type {string} * @memberof AccountExperienceColors */ 'input_foreground_tertiary'?: string; /** * * @type {string} * @memberof AccountExperienceColors */ 'interface_background_brand_primary'?: string; /** * * @type {string} * @memberof AccountExperienceColors */ 'interface_background_brand_primary_hover'?: string; /** * * @type {string} * @memberof AccountExperienceColors */ 'interface_background_brand_secondary'?: string; /** * * @type {string} * @memberof AccountExperienceColors */ 'interface_background_brand_secondary_hover'?: string; /** * * @type {string} * @memberof AccountExperienceColors */ 'interface_background_default_inverted'?: string; /** * * @type {string} * @memberof AccountExperienceColors */ 'interface_background_default_inverted_hover'?: string; /** * * @type {string} * @memberof AccountExperienceColors */ 'interface_background_default_none'?: string; /** * * @type {string} * @memberof AccountExperienceColors */ 'interface_background_default_primary'?: string; /** * * @type {string} * @memberof AccountExperienceColors */ 'interface_background_default_primary_hover'?: string; /** * * @type {string} * @memberof AccountExperienceColors */ 'interface_background_default_secondary'?: string; /** * * @type {string} * @memberof AccountExperienceColors */ 'interface_background_default_secondary_hover'?: string; /** * * @type {string} * @memberof AccountExperienceColors */ 'interface_background_default_tertiary'?: string; /** * * @type {string} * @memberof AccountExperienceColors */ 'interface_background_default_tertiary_hover'?: string; /** * * @type {string} * @memberof AccountExperienceColors */ 'interface_background_disabled_disabled'?: string; /** * * @type {string} * @memberof AccountExperienceColors */ 'interface_background_validation_danger'?: string; /** * * @type {string} * @memberof AccountExperienceColors */ 'interface_background_validation_success'?: string; /** * * @type {string} * @memberof AccountExperienceColors */ 'interface_background_validation_warning'?: string; /** * * @type {string} * @memberof AccountExperienceColors */ 'interface_border_brand_brand'?: string; /** * * @type {string} * @memberof AccountExperienceColors */ 'interface_border_default_inverted'?: string; /** * * @type {string} * @memberof AccountExperienceColors */ 'interface_border_default_none'?: string; /** * * @type {string} * @memberof AccountExperienceColors */ 'interface_border_default_primary'?: string; /** * * @type {string} * @memberof AccountExperienceColors */ 'interface_border_disabled_disabled'?: string; /** * * @type {string} * @memberof AccountExperienceColors */ 'interface_border_validation_danger'?: string; /** * * @type {string} * @memberof AccountExperienceColors */ 'interface_border_validation_success'?: string; /** * * @type {string} * @memberof AccountExperienceColors */ 'interface_border_validation_warning'?: string; /** * * @type {string} * @memberof AccountExperienceColors */ 'interface_foreground_brand_on_primary'?: string; /** * * @type {string} * @memberof AccountExperienceColors */ 'interface_foreground_brand_on_secondary'?: string; /** * * @type {string} * @memberof AccountExperienceColors */ 'interface_foreground_brand_primary'?: string; /** * * @type {string} * @memberof AccountExperienceColors */ 'interface_foreground_brand_secondary'?: string; /** * * @type {string} * @memberof AccountExperienceColors */ 'interface_foreground_default_inverted'?: string; /** * * @type {string} * @memberof AccountExperienceColors */ 'interface_foreground_default_primary'?: string; /** * * @type {string} * @memberof AccountExperienceColors */ 'interface_foreground_default_secondary'?: string; /** * * @type {string} * @memberof AccountExperienceColors */ 'interface_foreground_default_tertiary'?: string; /** * * @type {string} * @memberof AccountExperienceColors */ 'interface_foreground_disabled_disabled'?: string; /** * * @type {string} * @memberof AccountExperienceColors */ 'interface_foreground_disabled_on_disabled'?: string; /** * * @type {string} * @memberof AccountExperienceColors */ 'interface_foreground_validation_danger'?: string; /** * * @type {string} * @memberof AccountExperienceColors */ 'interface_foreground_validation_success'?: string; /** * * @type {string} * @memberof AccountExperienceColors */ 'interface_foreground_validation_warning'?: string; /** * * @type {string} * @memberof AccountExperienceColors */ 'ory_background_default'?: string; /** * * @type {string} * @memberof AccountExperienceColors */ 'ory_border_default'?: string; /** * * @type {string} * @memberof AccountExperienceColors */ 'ory_foreground_default'?: string; /** * * @type {string} * @memberof AccountExperienceColors */ 'radio_background_checked'?: string; /** * * @type {string} * @memberof AccountExperienceColors */ 'radio_background_default'?: string; /** * * @type {string} * @memberof AccountExperienceColors */ 'radio_border_checked'?: string; /** * * @type {string} * @memberof AccountExperienceColors */ 'radio_border_default'?: string; /** * * @type {string} * @memberof AccountExperienceColors */ 'radio_foreground_checked'?: string; /** * * @type {string} * @memberof AccountExperienceColors */ 'radio_foreground_default'?: string; /** * * @type {string} * @memberof AccountExperienceColors */ 'toggle_background_checked'?: string; /** * * @type {string} * @memberof AccountExperienceColors */ 'toggle_background_default'?: string; /** * * @type {string} * @memberof AccountExperienceColors */ 'toggle_border_checked'?: string; /** * * @type {string} * @memberof AccountExperienceColors */ 'toggle_border_default'?: string; /** * * @type {string} * @memberof AccountExperienceColors */ 'toggle_foreground_checked'?: string; /** * * @type {string} * @memberof AccountExperienceColors */ 'toggle_foreground_default'?: string; /** * * @type {string} * @memberof AccountExperienceColors */ 'ui_100'?: string; /** * * @type {string} * @memberof AccountExperienceColors */ 'ui_200'?: string; /** * * @type {string} * @memberof AccountExperienceColors */ 'ui_300'?: string; /** * * @type {string} * @memberof AccountExperienceColors */ 'ui_400'?: string; /** * * @type {string} * @memberof AccountExperienceColors */ 'ui_50'?: string; /** * * @type {string} * @memberof AccountExperienceColors */ 'ui_500'?: string; /** * * @type {string} * @memberof AccountExperienceColors */ 'ui_600'?: string; /** * * @type {string} * @memberof AccountExperienceColors */ 'ui_700'?: string; /** * * @type {string} * @memberof AccountExperienceColors */ 'ui_800'?: string; /** * * @type {string} * @memberof AccountExperienceColors */ 'ui_900'?: string; /** * * @type {string} * @memberof AccountExperienceColors */ 'ui_950'?: string; /** * * @type {string} * @memberof AccountExperienceColors */ 'ui_black'?: string; /** * * @type {string} * @memberof AccountExperienceColors */ 'ui_danger'?: string; /** * * @type {string} * @memberof AccountExperienceColors */ 'ui_success'?: string; /** * * @type {string} * @memberof AccountExperienceColors */ 'ui_transparent'?: string; /** * * @type {string} * @memberof AccountExperienceColors */ 'ui_warning'?: string; /** * * @type {string} * @memberof AccountExperienceColors */ 'ui_white'?: string; } /** * * @export * @interface AccountExperienceConfiguration */ export interface AccountExperienceConfiguration { /** * * @type {string} * @memberof AccountExperienceConfiguration */ 'default_locale': string; /** * * @type {string} * @memberof AccountExperienceConfiguration */ 'default_redirect_url': string; /** * * @type {Array<string>} * @memberof AccountExperienceConfiguration */ 'enabled_locales': Array<string>; /** * * @type {string} * @memberof AccountExperienceConfiguration */ 'error_ui_url': string; /** * * @type {string} * @memberof AccountExperienceConfiguration */ 'favicon_dark_url'?: string; /** * * @type {string} * @memberof AccountExperienceConfiguration */ 'favicon_light_url'?: string; /** * force_default AccountExperienceLocaleBehaviorForceDefault respect_accept_language AccountExperienceLocaleBehaviorRespectAcceptLanguage * @type {string} * @memberof AccountExperienceConfiguration */ 'locale_behavior': AccountExperienceConfigurationLocaleBehaviorEnum; /** * * @type {string} * @memberof AccountExperienceConfiguration */ 'login_ui_url': string; /** * * @type {string} * @memberof AccountExperienceConfiguration */ 'logo_dark_url'?: string; /** * * @type {string} * @memberof AccountExperienceConfiguration */ 'logo_light_url'?: string; /** * * @type {string} * @memberof AccountExperienceConfiguration */ 'name': string; /** * * @type {boolean} * @memberof AccountExperienceConfiguration */ 'recovery_enabled': boolean; /** * * @type {string} * @memberof AccountExperienceConfiguration */ 'recovery_ui_url': string; /** * * @type {boolean} * @memberof AccountExperienceConfiguration */ 'registration_enabled': boolean; /** * * @type {string} * @memberof AccountExperienceConfiguration */ 'registration_ui_url': string; /** * * @type {string} * @memberof AccountExperienceConfiguration */ 'settings_ui_url': string; /** * * @type {string} * @memberof AccountExperienceConfiguration */ 'stylesheet'?: string; /** * * @type {Array<RevisionAccountExperienceCustomTranslation>} * @memberof AccountExperienceConfiguration */ 'translations': Array<RevisionAccountExperienceCustomTranslation>; /** * * @type {boolean} * @memberof AccountExperienceConfiguration */ 'verification_enabled': boolean; /** * * @type {string} * @memberof AccountExperienceConfiguration */ 'verification_ui_url': string; } export declare const AccountExperienceConfigurationLocaleBehaviorEnum: { readonly ForceDefault: "force_default"; readonly RespectAcceptLanguage: "respect_accept_language"; readonly UnknownDefaultOpenApi: "11184809"; }; export type AccountExperienceConfigurationLocaleBehaviorEnum = typeof AccountExperienceConfigurationLocaleBehaviorEnum[keyof typeof AccountExperienceConfigurationLocaleBehaviorEnum]; /** * The Active Project ID * @export * @interface ActiveProjectInConsole */ export interface ActiveProjectInConsole { /** * The Active Project ID format: uuid * @type {string} * @memberof ActiveProjectInConsole */ 'project_id'?: string; } /** * * @export * @interface AddProjectToWorkspaceBody */ export interface AddProjectToWorkspaceBody { /** * The environment of the project in the workspace. Can be one of \"prod\" or \"dev\". Note that the number of projects in the \"prod\" environment is limited depending on the subscription. prod Production stage Staging dev Development * @type {string} * @memberof AddProjectToWorkspaceBody */ 'environment': AddProjectToWorkspaceBodyEnvironmentEnum; /** * The action to take with the project subscription. Can be one of \"migrate\", and \"ignore\". \"migrate\" will migrate the project subscription to the workspace. \"ignore\" will ignore the project subscription. migrate ProjectSubscriptionActionMigrate ProjectSubscriptionActionMigrate will migrate the project subscription to the workspace. ignore ProjectSubscriptionActionIgnore ProjectSubscriptionActionIgnore will ignore the project subscription. * @type {string} * @memberof AddProjectToWorkspaceBody */ 'project_subscription': AddProjectToWorkspaceBodyProjectSubscriptionEnum; } export declare const AddProjectToWorkspaceBodyEnvironmentEnum: { readonly Prod: "prod"; readonly Stage: "stage"; readonly Dev: "dev"; readonly UnknownDefaultOpenApi: "11184809"; }; export type AddProjectToWorkspaceBodyEnvironmentEnum = typeof AddProjectToWorkspaceBodyEnvironmentEnum[keyof typeof AddProjectToWorkspaceBodyEnvironmentEnum]; export declare const AddProjectToWorkspaceBodyProjectSubscriptionEnum: { readonly Migrate: "migrate"; readonly Ignore: "ignore"; readonly UnknownDefaultOpenApi: "11184809"; }; export type AddProjectToWorkspaceBodyProjectSubscriptionEnum = typeof AddProjectToWorkspaceBodyProjectSubscriptionEnum[keyof typeof AddProjectToWorkspaceBodyProjectSubscriptionEnum]; /** * * @export * @interface Attribute */ export interface Attribute { /** * * @type {string} * @memberof Attribute */ 'key'?: string; /** * * @type {string} * @memberof Attribute */ 'value'?: string; } /** * * @export * @interface AttributeFilter */ export interface AttributeFilter { /** * * @type {string} * @memberof AttributeFilter */ 'attribute'?: string; /** * * @type {string} * @memberof AttributeFilter */ 'condition'?: AttributeFilterConditionEnum; /** * * @type {string} * @memberof AttributeFilter */ 'value'?: string; } export declare const AttributeFilterConditionEnum: { readonly Equals: "equals"; readonly NotEquals: "not_equals"; readonly Contains: "contains"; readonly NotContains: "not_contains"; readonly Regex: "regex"; readonly NotRegex: "not_regex"; readonly Set: "set"; readonly NotSet: "not_set"; readonly UnknownDefaultOpenApi: "11184809"; }; export type AttributeFilterConditionEnum = typeof AttributeFilterConditionEnum[keyof typeof AttributeFilterConditionEnum]; /** * * @export * @interface AttributesCountDatapoint */ export interface AttributesCountDatapoint { /** * Count of the attribute value for given key * @type {number} * @memberof AttributesCountDatapoint */ 'count': number; /** * Name of the attribute value for given key * @type {string} * @memberof AttributesCountDatapoint */ 'name': string; } /** * The authenticator assurance level can be one of \"aal1\", \"aal2\", or \"aal3\". A higher number means that it is harder for an attacker to compromise the account. Generally, \"aal1\" implies that one authentication factor was used while AAL2 implies that two factors (e.g. password + TOTP) have been used. To learn more about these levels please head over to: https://www.ory.sh/kratos/docs/concepts/credentials * @export * @enum {string} */ export declare const AuthenticatorAssuranceLevel: { readonly Aal0: "aal0"; readonly Aal1: "aal1"; readonly Aal2: "aal2"; readonly Aal3: "aal3"; readonly UnknownDefaultOpenApi: "11184809"; }; export type AuthenticatorAssuranceLevel = typeof AuthenticatorAssuranceLevel[keyof typeof AuthenticatorAssuranceLevel]; /** * * @export * @interface BasicOrganization */ export interface BasicOrganization { /** * * @type {Array<string>} * @memberof BasicOrganization */ 'domains': Array<string>; /** * The organization\'s ID. * @type {string} * @memberof BasicOrganization */ 'id': string; /** * The organization\'s human-readable label. * @type {string} * @memberof BasicOrganization */ 'label': string; } /** * Batch Check Permission Body * @export * @interface BatchCheckPermissionBody */ export interface BatchCheckPermissionBody { /** * * @type {Array<Relationship>} * @memberof BatchCheckPermissionBody */ 'tuples'?: Array<Relationship>; } /** * Batch Check Permission Result * @export * @interface BatchCheckPermissionResult */ export interface BatchCheckPermissionResult { /** * An array of check results. The order aligns with the input order. * @type {Array<CheckPermissionResultWithError>} * @memberof BatchCheckPermissionResult */ 'results': Array<CheckPermissionResultWithError>; } /** * Patch identities response * @export * @interface BatchPatchIdentitiesResponse */ export interface BatchPatchIdentitiesResponse { /** * The patch responses for the individual identities. * @type {Array<IdentityPatchResponse>} * @memberof BatchPatchIdentitiesResponse */ 'identities'?: Array<IdentityPatchResponse>; } /** * * @export * @interface BillingPeriodBucket */ export interface BillingPeriodBucket { /** * * @type {Array<Invoice>} * @memberof BillingPeriodBucket */ 'base_invoices'?: Array<Invoice>; /** * * @type {TimeInterval} * @memberof BillingPeriodBucket */ 'billing_period'?: TimeInterval; /** * * @type {Invoice} * @memberof BillingPeriodBucket */ 'usage_invoice'?: Invoice; } /** * * @export * @interface CheckOplSyntaxResult */ export interface CheckOplSyntaxResult { /** * The list of syntax errors * @type {Array<ParseError>} * @memberof CheckOplSyntaxResult */ 'errors'?: Array<ParseError>; } /** * The content of the allowed field is mirrored in the HTTP status code. * @export * @interface CheckPermissionResult */ export interface CheckPermissionResult { /** * whether the relation tuple is allowed * @type {boolean} * @memberof CheckPermissionResult */ 'allowed': boolean; } /** * Check Permission Result With Error * @export * @interface CheckPermissionResultWithError */ export interface CheckPermissionResultWithError { /** * whether the relation tuple is allowed * @type {boolean} * @memberof CheckPermissionResultWithError */ 'allowed': boolean; /** * any error generated while checking the relation tuple * @type {string} * @memberof CheckPermissionResultWithError */ 'error'?: string; } /** * * @export * @interface CloudAccount */ export interface CloudAccount { /** * * @type {string} * @memberof CloudAccount */ 'email': string; /** * * @type {boolean} * @memberof CloudAccount */ 'email_verified': boolean; /** * * @type {string} * @memberof CloudAccount */ 'id': string; /** * * @type {string} * @memberof CloudAccount */ 'name': string; } /** * Control API consistency guarantees * @export * @interface ConsistencyRequestParameters */ export interface ConsistencyRequestParameters { /** * Read Consistency Level (preview) The read consistency level determines the consistency guarantee for reads: strong (slow): The read is guaranteed to return the most recent data committed at the start of the read. eventual (very fast): The result will return data that is about 4.8 seconds old. The default consistency guarantee can be changed in the Ory Network Console or using the Ory CLI with `ory patch project --replace \'/previews/default_read_consistency_level=\"strong\"\'`. Setting the default consistency level to `eventual` may cause regressions in the future as we add consistency controls to more APIs. Currently, the following APIs will be affected by this setting: `GET /admin/identities` This feature is in preview and only available in Ory Network. ConsistencyLevelUnset ConsistencyLevelUnset is the unset / default consistency level. strong ConsistencyLevelStrong ConsistencyLevelStrong is the strong consistency level. eventual ConsistencyLevelEventual ConsistencyLevelEventual is the eventual consistency level using follower read timestamps. * @type {string} * @memberof ConsistencyRequestParameters */ 'consistency'?: ConsistencyRequestParametersConsistencyEnum; } export declare const ConsistencyRequestParametersConsistencyEnum: { readonly Empty: ""; readonly Strong: "strong"; readonly Eventual: "eventual"; readonly UnknownDefaultOpenApi: "11184809"; }; export type ConsistencyRequestParametersConsistencyEnum = typeof ConsistencyRequestParametersConsistencyEnum[keyof typeof ConsistencyRequestParametersConsistencyEnum]; /** * @type ContinueWith * @export */ export type ContinueWith = { action: 'redirect_browser_to'; } & ContinueWithRedirectBrowserTo | { action: 'set_ory_session_token'; } & ContinueWithSetOrySessionToken | { action: 'show_recovery_ui'; } & ContinueWithRecoveryUi | { action: 'show_settings_ui'; } & ContinueWithSettingsUi | { action: 'show_verification_ui'; } & ContinueWithVerificationUi; /** * Indicates, that the UI flow could be continued by showing a recovery ui * @export * @interface ContinueWithRecoveryUi */ export interface ContinueWithRecoveryUi { /** * Action will always be `show_recovery_ui` show_recovery_ui ContinueWithActionShowRecoveryUIString * @type {string} * @memberof ContinueWithRecoveryUi */ 'action': ContinueWithRecoveryUiActionEnum; /** * * @type {ContinueWithRecoveryUiFlow} * @memberof ContinueWithRecoveryUi */ 'flow': ContinueWithRecoveryUiFlow; } export declare const ContinueWithRecoveryUiActionEnum: { readonly ShowRecoveryUi: "show_recovery_ui"; readonly UnknownDefaultOpenApi: "11184809"; }; export type ContinueWithRecoveryUiActionEnum = typeof ContinueWithRecoveryUiActionEnum[keyof typeof ContinueWithRecoveryUiActionEnum]; /** * * @export * @interface ContinueWithRecoveryUiFlow */ export interface ContinueWithRecoveryUiFlow { /** * The ID of the recovery flow * @type {string} * @memberof ContinueWithRecoveryUiFlow */ 'id': string; /** * The URL of the recovery flow If this value is set, redirect the user\'s browser to this URL. This value is typically unset for native clients / API flows. * @type {string} * @memberof ContinueWithRecoveryUiFlow */ 'url'?: string; } /** * Indicates, that the UI flow could be continued by showing a recovery ui * @export * @interface ContinueWithRedirectBrowserTo */ export interface ContinueWithRedirectBrowserTo { /** * Action will always be `redirect_browser_to` redirect_browser_to ContinueWithActionRedirectBrowserToString * @type {string} * @memberof ContinueWithRedirectBrowserTo */ 'action': ContinueWithRedirectBrowserToActionEnum; /** * The URL to redirect the browser to * @type {string} * @memberof ContinueWithRedirectBrowserTo */ 'redirect_browser_to': string; } export declare const ContinueWithRedirectBrowserToActionEnum: { readonly RedirectBrowserTo: "redirect_browser_to"; readonly UnknownDefaultOpenApi: "11184809"; }; export type ContinueWithRedirectBrowserToActionEnum = typeof ContinueWithRedirectBrowserToActionEnum[keyof typeof ContinueWithRedirectBrowserToActionEnum]; /** * Indicates that a session was issued, and the application should use this token for authenticated requests * @export * @interface ContinueWithSetOrySessionToken */ export interface ContinueWithSetOrySessionToken { /** * Action will always be `set_ory_session_token` set_ory_session_token ContinueWithActionSetOrySessionTokenString * @type {string} * @memberof ContinueWithSetOrySessionToken */ 'action': ContinueWithSetOrySessionTokenActionEnum; /** * Token is the token of the session * @type {string} * @memberof ContinueWithSetOrySessionToken */ 'ory_session_token': string; } export declare const ContinueWithSetOrySessionTokenActionEnum: { readonly SetOrySessionToken: "set_ory_session_token"; readonly UnknownDefaultOpenApi: "11184809"; }; export type ContinueWithSetOrySessionTokenActionEnum = typeof ContinueWithSetOrySessionTokenActionEnum[keyof typeof ContinueWithSetOrySessionTokenActionEnum]; /** * Indicates, that the UI flow could be continued by showing a settings ui * @export * @interface ContinueWithSettingsUi */ export interface ContinueWithSettingsUi { /** * Action will always be `show_settings_ui` show_settings_ui ContinueWithActionShowSettingsUIString * @type {string} * @memberof ContinueWithSettingsUi */ 'action': ContinueWithSettingsUiActionEnum; /** * * @type {ContinueWithSettingsUiFlow} * @memberof ContinueWithSettingsUi */ 'flow': ContinueWithSettingsUiFlow; } export declare const ContinueWithSettingsUiActionEnum: { readonly ShowSettingsUi: "show_settings_ui"; readonly UnknownDefaultOpenApi: "11184809"; }; export type ContinueWithSettingsUiActionEnum = typeof ContinueWithSettingsUiActionEnum[keyof typeof ContinueWithSettingsUiActionEnum]; /** * * @export * @interface ContinueWithSettingsUiFlow */ export interface ContinueWithSettingsUiFlow { /** * The ID of the settings flow * @type {string} * @memberof ContinueWithSettingsUiFlow */ 'id': string; /** * The URL of the settings flow If this value is set, redirect the user\'s browser to this URL. This value is typically unset for native clients / API flows. * @type {string} * @memberof ContinueWithSettingsUiFlow */ 'url'?: string; } /** * Indicates, that the UI flow could be continued by showing a verification ui * @export * @interface ContinueWithVerificationUi */ export interface ContinueWithVerificationUi { /** * Action will always be `show_verification_ui` show_verification_ui ContinueWithActionShowVerificationUIString * @type {string} * @memberof ContinueWithVerificationUi */ 'action': ContinueWithVerificationUiActionEnum; /** * * @type {ContinueWithVerificationUiFlow} * @memberof ContinueWithVerificationUi */ 'flow': ContinueWithVerificationUiFlow; } export declare const ContinueWithVerificationUiActionEnum: { readonly ShowVerificationUi: "show_verification_ui"; readonly UnknownDefaultOpenApi: "11184809"; }; export type ContinueWithVerificationUiActionEnum = typeof ContinueWithVerificationUiActionEnum[keyof typeof ContinueWithVerificationUiActionEnum]; /** * * @export * @interface ContinueWithVerificationUiFlow */ export interface ContinueWithVerificationUiFlow { /** * The ID of the verification flow * @type {string} * @memberof ContinueWithVerificationUiFlow */ 'id': string; /** * The URL of the verification flow If this value is set, redirect the user\'s browser to this URL. This value is typically unset for native clients / API flows. * @type {string} * @memberof ContinueWithVerificationUiFlow */ 'url'?: string; /** * The address that should be verified in this flow * @type {string} * @memberof ContinueWithVerificationUiFlow */ 'verifiable_address': string; } /** * A Message\'s Status * @export * @enum {string} */ export declare const CourierMessageStatus: { readonly Queued: "queued"; readonly Sent: "sent"; readonly Processing: "processing"; readonly Abandoned: "abandoned"; readonly UnknownDefaultOpenApi: "11184809"; }; export type CourierMessageStatus = typeof CourierMessageStatus[keyof typeof CourierMessageStatus]; /** * It can either be `email` or `phone` * @export * @enum {string} */ export declare const CourierMessageType: { readonly Email: "email"; readonly Phone: "phone"; readonly UnknownDefaultOpenApi: "11184809"; }; export type CourierMessageType = typeof CourierMessageType[keyof typeof CourierMessageType]; /** * Create Custom Hostname Request Body * @export * @interface CreateCustomDomainBody */ export interface CreateCustomDomainBody { /** * The domain where cookies will be set. Has to be a parent domain of the custom hostname to work. * @type {string} * @memberof CreateCustomDomainBody */ 'cookie_domain'?: string; /** * CORS Allowed origins for the custom hostname. * @type {Array<string>} * @memberof CreateCustomDomainBody */ 'cors_allowed_origins'?: Array<string>; /** * CORS Enabled for the custom hostname. * @type {boolean} * @memberof CreateCustomDomainBody */ 'cors_enabled'?: boolean; /** * The base URL where the custom user interface will be exposed. * @type {string} * @memberof CreateCustomDomainBody */ 'custom_ui_base_url'?: string; /** * The custom hostname where the API will be exposed. * @type {string} * @memberof CreateCustomDomainBody */ 'hostname'?: string; } /** * Create Event Stream Request Body * @export * @interface CreateEventStreamBody */ export interface CreateEventStreamBody { /** * The AWS IAM role ARN to assume when publishing to the SNS topic. * @type {string} * @memberof CreateEventStreamBody */ 'role_arn': string; /** * The AWS SNS topic ARN. * @type {string} * @memberof CreateEventStreamBody */ 'topic_arn': string; /** * The type of the event stream (AWS SNS, GCP Pub/Sub, etc). * @type {string} * @memberof CreateEventStreamBody */ 'type': CreateEventStreamBodyTypeEnum; } export declare const CreateEventStr