@ory/client
Version:
OpenAPI client for @ory/client
1,941 lines • 1.2 MB
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.21.3
* 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>;
/**
*
* @type {string}
* @memberof AcceptOAuth2ConsentRequest
*/
'handled_at'?: 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, he/she 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 {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 {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];
/**
*
* @export
* @interface AccountExperienceThemeVariables
*/
export interface AccountExperienceThemeVariables {
/**
*
* @type {string}
* @memberof AccountExperienceThemeVariables
*/
'accent'?: string;
/**
*
* @type {string}
* @memberof AccountExperienceThemeVariables
*/
'bg-default'?: string;
/**
*
* @type {string}
* @memberof AccountExperienceThemeVariables
*/
'border-radius-branding'?: string;
/**
*
* @type {string}
* @memberof AccountExperienceThemeVariables
*/
'border-radius-buttons'?: string;
/**
*
* @type {string}
* @memberof AccountExperienceThemeVariables
*/
'border-radius-cards'?: string;
/**
*
* @type {string}
* @memberof AccountExperienceThemeVariables
*/
'border-radius-forms'?: string;
/**
*
* @type {string}
* @memberof AccountExperienceThemeVariables
*/
'border-radius-general'?: string;
/**
*
* @type {string}
* @memberof AccountExperienceThemeVariables
*/
'button-primary-bg-default'?: string;
/**
*
* @type {string}
* @memberof AccountExperienceThemeVariables
*/
'button-primary-bg-disabled'?: string;
/**
*
* @type {string}
* @memberof AccountExperienceThemeVariables
*/
'button-primary-bg-hover'?: string;
/**
*
* @type {string}
* @memberof AccountExperienceThemeVariables
*/
'button-primary-border-default'?: string;
/**
*
* @type {string}
* @memberof AccountExperienceThemeVariables
*/
'button-primary-border-disabled'?: string;
/**
*
* @type {string}
* @memberof AccountExperienceThemeVariables
*/
'button-primary-border-hover'?: string;
/**
*
* @type {string}
* @memberof AccountExperienceThemeVariables
*/
'button-primary-fg-default'?: string;
/**
*
* @type {string}
* @memberof AccountExperienceThemeVariables
*/
'button-primary-fg-disabled'?: string;
/**
*
* @type {string}
* @memberof AccountExperienceThemeVariables
*/
'button-primary-fg-hover'?: string;
/**
*
* @type {string}
* @memberof AccountExperienceThemeVariables
*/
'button-secondary-bg-default'?: string;
/**
*
* @type {string}
* @memberof AccountExperienceThemeVariables
*/
'button-secondary-bg-disabled'?: string;
/**
*
* @type {string}
* @memberof AccountExperienceThemeVariables
*/
'button-secondary-bg-hover'?: string;
/**
*
* @type {string}
* @memberof AccountExperienceThemeVariables
*/
'button-secondary-border-default'?: string;
/**
*
* @type {string}
* @memberof AccountExperienceThemeVariables
*/
'button-secondary-border-disabled'?: string;
/**
*
* @type {string}
* @memberof AccountExperienceThemeVariables
*/
'button-secondary-border-hover'?: string;
/**
*
* @type {string}
* @memberof AccountExperienceThemeVariables
*/
'button-secondary-fg-default'?: string;
/**
*
* @type {string}
* @memberof AccountExperienceThemeVariables
*/
'button-secondary-fg-disabled'?: string;
/**
*
* @type {string}
* @memberof AccountExperienceThemeVariables
*/
'button-secondary-fg-hover'?: string;
/**
*
* @type {string}
* @memberof AccountExperienceThemeVariables
*/
'button-social-bg-default'?: string;
/**
*
* @type {string}
* @memberof AccountExperienceThemeVariables
*/
'button-social-bg-disabled'?: string;
/**
*
* @type {string}
* @memberof AccountExperienceThemeVariables
*/
'button-social-bg-hover'?: string;
/**
*
* @type {string}
* @memberof AccountExperienceThemeVariables
*/
'button-social-bg-provider'?: string;
/**
*
* @type {string}
* @memberof AccountExperienceThemeVariables
*/
'button-social-border-default'?: string;
/**
*
* @type {string}
* @memberof AccountExperienceThemeVariables
*/
'button-social-border-disabled'?: string;
/**
*
* @type {string}
* @memberof AccountExperienceThemeVariables
*/
'button-social-border-hover'?: string;
/**
*
* @type {string}
* @memberof AccountExperienceThemeVariables
*/
'button-social-border-provider'?: string;
/**
*
* @type {string}
* @memberof AccountExperienceThemeVariables
*/
'button-social-fg-default'?: string;
/**
*
* @type {string}
* @memberof AccountExperienceThemeVariables
*/
'button-social-fg-disabled'?: string;
/**
*
* @type {string}
* @memberof AccountExperienceThemeVariables
*/
'button-social-fg-hover'?: string;
/**
*
* @type {string}
* @memberof AccountExperienceThemeVariables
*/
'button-social-fg-provider'?: string;
/**
*
* @type {string}
* @memberof AccountExperienceThemeVariables
*/
'created_at'?: string;
/**
*
* @type {string}
* @memberof AccountExperienceThemeVariables
*/
'dialog-bg-default'?: string;
/**
*
* @type {string}
* @memberof AccountExperienceThemeVariables
*/
'dialog-bg-subtle'?: string;
/**
*
* @type {string}
* @memberof AccountExperienceThemeVariables
*/
'dialog-border-default'?: string;
/**
*
* @type {string}
* @memberof AccountExperienceThemeVariables
*/
'dialog-fg-default'?: string;
/**
*
* @type {string}
* @memberof AccountExperienceThemeVariables
*/
'dialog-fg-mute'?: string;
/**
*
* @type {string}
* @memberof AccountExperienceThemeVariables
*/
'dialog-fg-subtle'?: string;
/**
*
* @type {string}
* @memberof AccountExperienceThemeVariables
*/
'forms-bg-default'?: string;
/**
*
* @type {string}
* @memberof AccountExperienceThemeVariables
*/
'forms-bg-disabled'?: string;
/**
*
* @type {string}
* @memberof AccountExperienceThemeVariables
*/
'forms-bg-hover'?: string;
/**
*
* @type {string}
* @memberof AccountExperienceThemeVariables
*/
'forms-border-default'?: string;
/**
*
* @type {string}
* @memberof AccountExperienceThemeVariables
*/
'forms-border-disabled'?: string;
/**
*
* @type {string}
* @memberof AccountExperienceThemeVariables
*/
'forms-border-error'?: string;
/**
*
* @type {string}
* @memberof AccountExperienceThemeVariables
*/
'forms-border-focus'?: string;
/**
*
* @type {string}
* @memberof AccountExperienceThemeVariables
*/
'forms-border-hover'?: string;
/**
*
* @type {string}
* @memberof AccountExperienceThemeVariables
*/
'forms-border-success'?: string;
/**
*
* @type {string}
* @memberof AccountExperienceThemeVariables
*/
'forms-border-warn'?: string;
/**
*
* @type {string}
* @memberof AccountExperienceThemeVariables
*/
'forms-checkbox-bg-checked'?: string;
/**
*
* @type {string}
* @memberof AccountExperienceThemeVariables
*/
'forms-checkbox-bg-default'?: string;
/**
*
* @type {string}
* @memberof AccountExperienceThemeVariables
*/
'forms-checkbox-border-checked'?: string;
/**
*
* @type {string}
* @memberof AccountExperienceThemeVariables
*/
'forms-checkbox-border-default'?: string;
/**
*
* @type {string}
* @memberof AccountExperienceThemeVariables
*/
'forms-checkbox-fg-checked'?: string;
/**
*
* @type {string}
* @memberof AccountExperienceThemeVariables
*/
'forms-checkbox-fg-default'?: string;
/**
*
* @type {string}
* @memberof AccountExperienceThemeVariables
*/
'forms-fg-default'?: string;
/**
*
* @type {string}
* @memberof AccountExperienceThemeVariables
*/
'forms-fg-error'?: string;
/**
*
* @type {string}
* @memberof AccountExperienceThemeVariables
*/
'forms-fg-mute'?: string;
/**
*
* @type {string}
* @memberof AccountExperienceThemeVariables
*/
'forms-fg-subtle'?: string;
/**
*
* @type {string}
* @memberof AccountExperienceThemeVariables
*/
'forms-fg-success'?: string;
/**
*
* @type {string}
* @memberof AccountExperienceThemeVariables
*/
'forms-fg-warn'?: string;
/**
*
* @type {string}
* @memberof AccountExperienceThemeVariables
*/
'forms-radio-bg-checked'?: string;
/**
*
* @type {string}
* @memberof AccountExperienceThemeVariables
*/
'forms-radio-bg-default'?: string;
/**
*
* @type {string}
* @memberof AccountExperienceThemeVariables
*/
'forms-radio-border-checked'?: string;
/**
*
* @type {string}
* @memberof AccountExperienceThemeVariables
*/
'forms-radio-border-default'?: string;
/**
*
* @type {string}
* @memberof AccountExperienceThemeVariables
*/
'forms-radio-fg-checked'?: string;
/**
*
* @type {string}
* @memberof AccountExperienceThemeVariables
*/
'forms-radio-fg-default'?: string;
/**
*
* @type {string}
* @memberof AccountExperienceThemeVariables
*/
'forms-toggle-bg-checked'?: string;
/**
*
* @type {string}
* @memberof AccountExperienceThemeVariables
*/
'forms-toggle-bg-default'?: string;
/**
*
* @type {string}
* @memberof AccountExperienceThemeVariables
*/
'forms-toggle-border-checked'?: string;
/**
*
* @type {string}
* @memberof AccountExperienceThemeVariables
*/
'forms-toggle-border-default'?: string;
/**
*
* @type {string}
* @memberof AccountExperienceThemeVariables
*/
'forms-toggle-fg-checked'?: string;
/**
*
* @type {string}
* @memberof AccountExperienceThemeVariables
*/
'forms-toggle-fg-default'?: string;
/**
*
* @type {string}
* @memberof AccountExperienceThemeVariables
*/
'id'?: string;
/**
*
* @type {string}
* @memberof AccountExperienceThemeVariables
*/
'links-link-default'?: string;
/**
*
* @type {string}
* @memberof AccountExperienceThemeVariables
*/
'links-link-disabled'?: string;
/**
*
* @type {string}
* @memberof AccountExperienceThemeVariables
*/
'links-link-hover'?: string;
/**
*
* @type {string}
* @memberof AccountExperienceThemeVariables
*/
'links-link-inverted-default'?: string;
/**
*
* @type {string}
* @memberof AccountExperienceThemeVariables
*/
'links-link-inverted-hover'?: string;
/**
*
* @type {string}
* @memberof AccountExperienceThemeVariables
*/
'links-link-mute-default'?: string;
/**
*
* @type {string}
* @memberof AccountExperienceThemeVariables
*/
'links-link-mute-hover'?: string;
/**
*
* @type {string}
* @memberof AccountExperienceThemeVariables
*/
'syntax-syntax'?: string;
/**
*
* @type {string}
* @memberof AccountExperienceThemeVariables
*/
'syntax-syntax-key'?: string;
/**
*
* @type {string}
* @memberof AccountExperienceThemeVariables
*/
'syntax-syntax-num'?: string;
/**
*
* @type {string}
* @memberof AccountExperienceThemeVariables
*/
'syntax-syntax-value'?: string;
/**
*
* @type {string}
* @memberof AccountExperienceThemeVariables
*/
'updated_at'?: string;
}
/**
* 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