@leancodepl/kratos

/** * 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 NormalizedProjectRevisionThirdPartyProvider */ export interface NormalizedProjectRevisionThirdPartyProvider { /** * * @type {Array<string>} * @memberof NormalizedProjectRevisionThirdPartyProvider */ additional_id_token_audiences?: Array<string>; /** * * @type {string} * @memberof NormalizedProjectRevisionThirdPartyProvider */ apple_private_key?: string | null; /** * Apple Private Key Identifier * * Sign In with Apple Private Key Identifier needed for generating a JWT token for client secret * @type {string} * @memberof NormalizedProjectRevisionThirdPartyProvider */ apple_private_key_id?: string; /** * Apple Developer Team ID * * Apple Developer Team ID needed for generating a JWT token for client secret * @type {string} * @memberof NormalizedProjectRevisionThirdPartyProvider */ apple_team_id?: string; /** * AuthURL is the authorize url, typically something like: https://example.org/oauth2/auth * Should only be used when the OAuth2 / OpenID Connect server is not supporting OpenID Connect Discovery and when * `provider` is set to `generic`. * @type {string} * @memberof NormalizedProjectRevisionThirdPartyProvider */ auth_url?: string; /** * Tenant is the Azure AD Tenant to use for authentication, and must be set when `provider` is set to `microsoft`. * * Can be either `common`, `organizations`, `consumers` for a multitenant application or a specific tenant like * `8eaef023-2b34-4da1-9baa-8bc8c9d6a490` or `contoso.onmicrosoft.com`. * @type {string} * @memberof NormalizedProjectRevisionThirdPartyProvider */ azure_tenant?: string; /** * * @type {string} * @memberof NormalizedProjectRevisionThirdPartyProvider */ claims_source?: string | null; /** * ClientID is the application's Client ID. * @type {string} * @memberof NormalizedProjectRevisionThirdPartyProvider */ client_id?: string; /** * * @type {string} * @memberof NormalizedProjectRevisionThirdPartyProvider */ client_secret?: string | null; /** * The Project's Revision Creation Date * @type {Date} * @memberof NormalizedProjectRevisionThirdPartyProvider */ readonly created_at?: Date; /** * * @type {string} * @memberof NormalizedProjectRevisionThirdPartyProvider */ fedcm_config_url?: string | null; /** * * @type {string} * @memberof NormalizedProjectRevisionThirdPartyProvider */ id?: string; /** * IssuerURL is the OpenID Connect Server URL. You can leave this empty if `provider` is not set to `generic`. * If set, neither `auth_url` nor `token_url` are required. * @type {string} * @memberof NormalizedProjectRevisionThirdPartyProvider */ issuer_url?: string; /** * Label represents an optional label which can be used in the UI generation. * @type {string} * @memberof NormalizedProjectRevisionThirdPartyProvider */ label?: string; /** * Mapper specifies the JSONNet code snippet which uses the OpenID Connect Provider's data (e.g. GitHub or Google * profile information) to hydrate the identity's data. * @type {string} * @memberof NormalizedProjectRevisionThirdPartyProvider */ mapper_url?: string; /** * * @type {string} * @memberof NormalizedProjectRevisionThirdPartyProvider */ net_id_token_origin_header?: string | null; /** * * @type {string} * @memberof NormalizedProjectRevisionThirdPartyProvider */ organization_id?: string | null; /** * PKCE controls if the OpenID Connect OAuth2 flow should use PKCE (Proof Key for Code Exchange). * Possible values are: `auto` (default), `never`, `force`. * `auto`: PKCE is used if the provider supports it. Requires setting `issuer_url`. * `never`: Disable PKCE entirely for this provider, even if the provider advertises support for it. * `force`: Always use PKCE, even if the provider does not advertise support for it. OAuth2 flows will fail if the provider does not support PKCE. * IMPORTANT: If you set this to `force`, you must whitelist a different return URL for your OAuth2 client in the provider's configuration. * Instead of <base-url>/self-service/methods/oidc/callback/<provider>, you must use <base-url>/self-service/methods/oidc/callback * (Note the missing <provider> path segment and no trailing slash). * @type {string} * @memberof NormalizedProjectRevisionThirdPartyProvider */ pkce?: NormalizedProjectRevisionThirdPartyProviderPkceEnum | null; /** * The Revision's ID this schema belongs to * @type {string} * @memberof NormalizedProjectRevisionThirdPartyProvider */ project_revision_id?: string; /** * Provider is either "generic" for a generic OAuth 2.0 / OpenID Connect Provider or one of: * generic * google * github * gitlab * microsoft * discord * slack * facebook * vk * yandex * apple * @type {string} * @memberof NormalizedProjectRevisionThirdPartyProvider */ provider?: string; /** * ID is the provider's ID * @type {string} * @memberof NormalizedProjectRevisionThirdPartyProvider */ provider_id?: string; /** * * @type {object} * @memberof NormalizedProjectRevisionThirdPartyProvider */ requested_claims?: object; /** * * @type {Array<string>} * @memberof NormalizedProjectRevisionThirdPartyProvider */ scope?: Array<string>; /** * State indicates the state of the provider * * Only providers with state `enabled` will be used for authentication * enabled ThirdPartyProviderStateEnabled * disabled ThirdPartyProviderStateDisabled * @type {string} * @memberof NormalizedProjectRevisionThirdPartyProvider */ state?: NormalizedProjectRevisionThirdPartyProviderStateEnum; /** * * @type {string} * @memberof NormalizedProjectRevisionThirdPartyProvider */ subject_source?: string | null; /** * TokenURL is the token url, typically something like: https://example.org/oauth2/token * * Should only be used when the OAuth2 / OpenID Connect server is not supporting OpenID Connect Discovery and when * `provider` is set to `generic`. * @type {string} * @memberof NormalizedProjectRevisionThirdPartyProvider */ token_url?: string; /** * Last Time Project's Revision was Updated * @type {Date} * @memberof NormalizedProjectRevisionThirdPartyProvider */ readonly updated_at?: Date; } /** * @export */ export declare const NormalizedProjectRevisionThirdPartyProviderPkceEnum: { readonly Auto: "auto"; readonly Never: "never"; readonly Force: "force"; readonly UnknownDefaultOpenApi: "11184809"; }; export type NormalizedProjectRevisionThirdPartyProviderPkceEnum = typeof NormalizedProjectRevisionThirdPartyProviderPkceEnum[keyof typeof NormalizedProjectRevisionThirdPartyProviderPkceEnum]; /** * @export */ export declare const NormalizedProjectRevisionThirdPartyProviderStateEnum: { readonly Enabled: "enabled"; readonly Disabled: "disabled"; readonly UnknownDefaultOpenApi: "11184809"; }; export type NormalizedProjectRevisionThirdPartyProviderStateEnum = typeof NormalizedProjectRevisionThirdPartyProviderStateEnum[keyof typeof NormalizedProjectRevisionThirdPartyProviderStateEnum]; /** * Check if a given object implements the NormalizedProjectRevisionThirdPartyProvider interface. */ export declare function instanceOfNormalizedProjectRevisionThirdPartyProvider(value: object): value is NormalizedProjectRevisionThirdPartyProvider; export declare function NormalizedProjectRevisionThirdPartyProviderFromJSON(json: any): NormalizedProjectRevisionThirdPartyProvider; export declare function NormalizedProjectRevisionThirdPartyProviderFromJSONTyped(json: any, ignoreDiscriminator: boolean): NormalizedProjectRevisionThirdPartyProvider; export declare function NormalizedProjectRevisionThirdPartyProviderToJSON(json: any): NormalizedProjectRevisionThirdPartyProvider; export declare function NormalizedProjectRevisionThirdPartyProviderToJSONTyped(value?: Omit<NormalizedProjectRevisionThirdPartyProvider, 'created_at' | 'updated_at'> | null, ignoreDiscriminator?: boolean): any;