cloudflare/resources/zero-trust/identity-providers/identity-providers.d.ts

The official TypeScript library for the Cloudflare API

import { APIResource } from "../../../resource.js";
import * as Core from "../../../core.js";
import * as IdentityProvidersAPI from "./identity-providers.js";
import * as SCIMAPI from "./scim/scim.js";
import { SCIM } from "./scim/scim.js";
import { SinglePage } from "../../../pagination.js";
export declare class IdentityProviders extends APIResource {
    scim: SCIMAPI.SCIM;
    /**
     * Adds a new identity provider to Access.
     */
    create(params: IdentityProviderCreateParams, options?: Core.RequestOptions): Core.APIPromise<IdentityProvider>;
    /**
     * Updates a configured identity provider.
     */
    update(identityProviderId: string, params: IdentityProviderUpdateParams, options?: Core.RequestOptions): Core.APIPromise<IdentityProvider>;
    /**
     * Lists all configured identity providers.
     */
    list(params?: IdentityProviderListParams, options?: Core.RequestOptions): Core.PagePromise<IdentityProviderListResponsesSinglePage, IdentityProviderListResponse>;
    list(options?: Core.RequestOptions): Core.PagePromise<IdentityProviderListResponsesSinglePage, IdentityProviderListResponse>;
    /**
     * Deletes an identity provider from Access.
     */
    delete(identityProviderId: string, params?: IdentityProviderDeleteParams, options?: Core.RequestOptions): Core.APIPromise<IdentityProviderDeleteResponse>;
    delete(identityProviderId: string, options?: Core.RequestOptions): Core.APIPromise<IdentityProviderDeleteResponse>;
    /**
     * Fetches a configured identity provider.
     */
    get(identityProviderId: string, params?: IdentityProviderGetParams, options?: Core.RequestOptions): Core.APIPromise<IdentityProvider>;
    get(identityProviderId: string, options?: Core.RequestOptions): Core.APIPromise<IdentityProvider>;
}
export declare class IdentityProviderListResponsesSinglePage extends SinglePage<IdentityProviderListResponse> {
}
export interface AzureAD {
    /**
     * The configuration parameters for the identity provider. To view the required
     * parameters for a specific provider, refer to our
     * [developer documentation](https://developers.cloudflare.com/cloudflare-one/identity/idp-integration/).
     */
    config: AzureAD.Config;
    /**
     * The name of the identity provider, shown to users on the login page.
     */
    name: string;
    /**
     * The type of identity provider. To determine the value for a specific provider,
     * refer to our
     * [developer documentation](https://developers.cloudflare.com/cloudflare-one/identity/idp-integration/).
     */
    type: IdentityProviderType;
    /**
     * UUID
     */
    id?: string;
    /**
     * The configuration settings for enabling a System for Cross-Domain Identity
     * Management (SCIM) with the identity provider.
     */
    scim_config?: IdentityProviderSCIMConfig;
}
export declare namespace AzureAD {
    /**
     * The configuration parameters for the identity provider. To view the required
     * parameters for a specific provider, refer to our
     * [developer documentation](https://developers.cloudflare.com/cloudflare-one/identity/idp-integration/).
     */
    interface Config {
        /**
         * Custom claims
         */
        claims?: Array<string>;
        /**
         * Your OAuth Client ID
         */
        client_id?: string;
        /**
         * Your OAuth Client Secret
         */
        client_secret?: string;
        /**
         * Should Cloudflare try to load authentication contexts from your account
         */
        conditional_access_enabled?: boolean;
        /**
         * Your Azure directory uuid
         */
        directory_id?: string;
        /**
         * The claim name for email in the id_token response.
         */
        email_claim_name?: string;
        /**
         * Indicates the type of user interaction that is required. prompt=login forces the
         * user to enter their credentials on that request, negating single-sign on.
         * prompt=none is the opposite. It ensures that the user isn't presented with any
         * interactive prompt. If the request can't be completed silently by using
         * single-sign on, the Microsoft identity platform returns an interaction_required
         * error. prompt=select_account interrupts single sign-on providing account
         * selection experience listing all the accounts either in session or any
         * remembered account or an option to choose to use a different account altogether.
         */
        prompt?: 'login' | 'select_account' | 'none';
        /**
         * Should Cloudflare try to load groups from your account
         */
        support_groups?: boolean;
    }
}
export interface AzureADParam {
    /**
     * The configuration parameters for the identity provider. To view the required
     * parameters for a specific provider, refer to our
     * [developer documentation](https://developers.cloudflare.com/cloudflare-one/identity/idp-integration/).
     */
    config: AzureADParam.Config;
    /**
     * The name of the identity provider, shown to users on the login page.
     */
    name: string;
    /**
     * The type of identity provider. To determine the value for a specific provider,
     * refer to our
     * [developer documentation](https://developers.cloudflare.com/cloudflare-one/identity/idp-integration/).
     */
    type: IdentityProviderTypeParam;
    /**
     * The configuration settings for enabling a System for Cross-Domain Identity
     * Management (SCIM) with the identity provider.
     */
    scim_config?: IdentityProviderSCIMConfigParam;
}
export declare namespace AzureADParam {
    /**
     * The configuration parameters for the identity provider. To view the required
     * parameters for a specific provider, refer to our
     * [developer documentation](https://developers.cloudflare.com/cloudflare-one/identity/idp-integration/).
     */
    interface Config {
        /**
         * Custom claims
         */
        claims?: Array<string>;
        /**
         * Your OAuth Client ID
         */
        client_id?: string;
        /**
         * Your OAuth Client Secret
         */
        client_secret?: string;
        /**
         * Should Cloudflare try to load authentication contexts from your account
         */
        conditional_access_enabled?: boolean;
        /**
         * Your Azure directory uuid
         */
        directory_id?: string;
        /**
         * The claim name for email in the id_token response.
         */
        email_claim_name?: string;
        /**
         * Indicates the type of user interaction that is required. prompt=login forces the
         * user to enter their credentials on that request, negating single-sign on.
         * prompt=none is the opposite. It ensures that the user isn't presented with any
         * interactive prompt. If the request can't be completed silently by using
         * single-sign on, the Microsoft identity platform returns an interaction_required
         * error. prompt=select_account interrupts single sign-on providing account
         * selection experience listing all the accounts either in session or any
         * remembered account or an option to choose to use a different account altogether.
         */
        prompt?: 'login' | 'select_account' | 'none';
        /**
         * Should Cloudflare try to load groups from your account
         */
        support_groups?: boolean;
    }
}
export interface GenericOAuthConfig {
    /**
     * Your OAuth Client ID
     */
    client_id?: string;
    /**
     * Your OAuth Client Secret
     */
    client_secret?: string;
}
export interface GenericOAuthConfigParam {
    /**
     * Your OAuth Client ID
     */
    client_id?: string;
    /**
     * Your OAuth Client Secret
     */
    client_secret?: string;
}
export type IdentityProvider = AzureAD | IdentityProvider.AccessCentrify | IdentityProvider.AccessFacebook | IdentityProvider.AccessGitHub | IdentityProvider.AccessGoogle | IdentityProvider.AccessGoogleApps | IdentityProvider.AccessLinkedin | IdentityProvider.AccessOIDC | IdentityProvider.AccessOkta | IdentityProvider.AccessOnelogin | IdentityProvider.AccessPingone | IdentityProvider.AccessSAML | IdentityProvider.AccessYandex | IdentityProvider.AccessOnetimepin;
export declare namespace IdentityProvider {
    interface AccessCentrify {
        /**
         * The configuration parameters for the identity provider. To view the required
         * parameters for a specific provider, refer to our
         * [developer documentation](https://developers.cloudflare.com/cloudflare-one/identity/idp-integration/).
         */
        config: AccessCentrify.Config;
        /**
         * The name of the identity provider, shown to users on the login page.
         */
        name: string;
        /**
         * The type of identity provider. To determine the value for a specific provider,
         * refer to our
         * [developer documentation](https://developers.cloudflare.com/cloudflare-one/identity/idp-integration/).
         */
        type: IdentityProvidersAPI.IdentityProviderType;
        /**
         * UUID
         */
        id?: string;
        /**
         * The configuration settings for enabling a System for Cross-Domain Identity
         * Management (SCIM) with the identity provider.
         */
        scim_config?: IdentityProvidersAPI.IdentityProviderSCIMConfig;
    }
    namespace AccessCentrify {
        /**
         * The configuration parameters for the identity provider. To view the required
         * parameters for a specific provider, refer to our
         * [developer documentation](https://developers.cloudflare.com/cloudflare-one/identity/idp-integration/).
         */
        interface Config {
            /**
             * Your centrify account url
             */
            centrify_account?: string;
            /**
             * Your centrify app id
             */
            centrify_app_id?: string;
            /**
             * Custom claims
             */
            claims?: Array<string>;
            /**
             * Your OAuth Client ID
             */
            client_id?: string;
            /**
             * Your OAuth Client Secret
             */
            client_secret?: string;
            /**
             * The claim name for email in the id_token response.
             */
            email_claim_name?: string;
        }
    }
    interface AccessFacebook {
        /**
         * The configuration parameters for the identity provider. To view the required
         * parameters for a specific provider, refer to our
         * [developer documentation](https://developers.cloudflare.com/cloudflare-one/identity/idp-integration/).
         */
        config: IdentityProvidersAPI.GenericOAuthConfig;
        /**
         * The name of the identity provider, shown to users on the login page.
         */
        name: string;
        /**
         * The type of identity provider. To determine the value for a specific provider,
         * refer to our
         * [developer documentation](https://developers.cloudflare.com/cloudflare-one/identity/idp-integration/).
         */
        type: IdentityProvidersAPI.IdentityProviderType;
        /**
         * UUID
         */
        id?: string;
        /**
         * The configuration settings for enabling a System for Cross-Domain Identity
         * Management (SCIM) with the identity provider.
         */
        scim_config?: IdentityProvidersAPI.IdentityProviderSCIMConfig;
    }
    interface AccessGitHub {
        /**
         * The configuration parameters for the identity provider. To view the required
         * parameters for a specific provider, refer to our
         * [developer documentation](https://developers.cloudflare.com/cloudflare-one/identity/idp-integration/).
         */
        config: IdentityProvidersAPI.GenericOAuthConfig;
        /**
         * The name of the identity provider, shown to users on the login page.
         */
        name: string;
        /**
         * The type of identity provider. To determine the value for a specific provider,
         * refer to our
         * [developer documentation](https://developers.cloudflare.com/cloudflare-one/identity/idp-integration/).
         */
        type: IdentityProvidersAPI.IdentityProviderType;
        /**
         * UUID
         */
        id?: string;
        /**
         * The configuration settings for enabling a System for Cross-Domain Identity
         * Management (SCIM) with the identity provider.
         */
        scim_config?: IdentityProvidersAPI.IdentityProviderSCIMConfig;
    }
    interface AccessGoogle {
        /**
         * The configuration parameters for the identity provider. To view the required
         * parameters for a specific provider, refer to our
         * [developer documentation](https://developers.cloudflare.com/cloudflare-one/identity/idp-integration/).
         */
        config: AccessGoogle.Config;
        /**
         * The name of the identity provider, shown to users on the login page.
         */
        name: string;
        /**
         * The type of identity provider. To determine the value for a specific provider,
         * refer to our
         * [developer documentation](https://developers.cloudflare.com/cloudflare-one/identity/idp-integration/).
         */
        type: IdentityProvidersAPI.IdentityProviderType;
        /**
         * UUID
         */
        id?: string;
        /**
         * The configuration settings for enabling a System for Cross-Domain Identity
         * Management (SCIM) with the identity provider.
         */
        scim_config?: IdentityProvidersAPI.IdentityProviderSCIMConfig;
    }
    namespace AccessGoogle {
        /**
         * The configuration parameters for the identity provider. To view the required
         * parameters for a specific provider, refer to our
         * [developer documentation](https://developers.cloudflare.com/cloudflare-one/identity/idp-integration/).
         */
        interface Config {
            /**
             * Custom claims
             */
            claims?: Array<string>;
            /**
             * Your OAuth Client ID
             */
            client_id?: string;
            /**
             * Your OAuth Client Secret
             */
            client_secret?: string;
            /**
             * The claim name for email in the id_token response.
             */
            email_claim_name?: string;
        }
    }
    interface AccessGoogleApps {
        /**
         * The configuration parameters for the identity provider. To view the required
         * parameters for a specific provider, refer to our
         * [developer documentation](https://developers.cloudflare.com/cloudflare-one/identity/idp-integration/).
         */
        config: AccessGoogleApps.Config;
        /**
         * The name of the identity provider, shown to users on the login page.
         */
        name: string;
        /**
         * The type of identity provider. To determine the value for a specific provider,
         * refer to our
         * [developer documentation](https://developers.cloudflare.com/cloudflare-one/identity/idp-integration/).
         */
        type: IdentityProvidersAPI.IdentityProviderType;
        /**
         * UUID
         */
        id?: string;
        /**
         * The configuration settings for enabling a System for Cross-Domain Identity
         * Management (SCIM) with the identity provider.
         */
        scim_config?: IdentityProvidersAPI.IdentityProviderSCIMConfig;
    }
    namespace AccessGoogleApps {
        /**
         * The configuration parameters for the identity provider. To view the required
         * parameters for a specific provider, refer to our
         * [developer documentation](https://developers.cloudflare.com/cloudflare-one/identity/idp-integration/).
         */
        interface Config {
            /**
             * Your companies TLD
             */
            apps_domain?: string;
            /**
             * Custom claims
             */
            claims?: Array<string>;
            /**
             * Your OAuth Client ID
             */
            client_id?: string;
            /**
             * Your OAuth Client Secret
             */
            client_secret?: string;
            /**
             * The claim name for email in the id_token response.
             */
            email_claim_name?: string;
        }
    }
    interface AccessLinkedin {
        /**
         * The configuration parameters for the identity provider. To view the required
         * parameters for a specific provider, refer to our
         * [developer documentation](https://developers.cloudflare.com/cloudflare-one/identity/idp-integration/).
         */
        config: IdentityProvidersAPI.GenericOAuthConfig;
        /**
         * The name of the identity provider, shown to users on the login page.
         */
        name: string;
        /**
         * The type of identity provider. To determine the value for a specific provider,
         * refer to our
         * [developer documentation](https://developers.cloudflare.com/cloudflare-one/identity/idp-integration/).
         */
        type: IdentityProvidersAPI.IdentityProviderType;
        /**
         * UUID
         */
        id?: string;
        /**
         * The configuration settings for enabling a System for Cross-Domain Identity
         * Management (SCIM) with the identity provider.
         */
        scim_config?: IdentityProvidersAPI.IdentityProviderSCIMConfig;
    }
    interface AccessOIDC {
        /**
         * The configuration parameters for the identity provider. To view the required
         * parameters for a specific provider, refer to our
         * [developer documentation](https://developers.cloudflare.com/cloudflare-one/identity/idp-integration/).
         */
        config: AccessOIDC.Config;
        /**
         * The name of the identity provider, shown to users on the login page.
         */
        name: string;
        /**
         * The type of identity provider. To determine the value for a specific provider,
         * refer to our
         * [developer documentation](https://developers.cloudflare.com/cloudflare-one/identity/idp-integration/).
         */
        type: IdentityProvidersAPI.IdentityProviderType;
        /**
         * UUID
         */
        id?: string;
        /**
         * The configuration settings for enabling a System for Cross-Domain Identity
         * Management (SCIM) with the identity provider.
         */
        scim_config?: IdentityProvidersAPI.IdentityProviderSCIMConfig;
    }
    namespace AccessOIDC {
        /**
         * The configuration parameters for the identity provider. To view the required
         * parameters for a specific provider, refer to our
         * [developer documentation](https://developers.cloudflare.com/cloudflare-one/identity/idp-integration/).
         */
        interface Config {
            /**
             * The authorization_endpoint URL of your IdP
             */
            auth_url?: string;
            /**
             * The jwks_uri endpoint of your IdP to allow the IdP keys to sign the tokens
             */
            certs_url?: string;
            /**
             * Custom claims
             */
            claims?: Array<string>;
            /**
             * Your OAuth Client ID
             */
            client_id?: string;
            /**
             * Your OAuth Client Secret
             */
            client_secret?: string;
            /**
             * The claim name for email in the id_token response.
             */
            email_claim_name?: string;
            /**
             * Enable Proof Key for Code Exchange (PKCE)
             */
            pkce_enabled?: boolean;
            /**
             * OAuth scopes
             */
            scopes?: Array<string>;
            /**
             * The token_endpoint URL of your IdP
             */
            token_url?: string;
        }
    }
    interface AccessOkta {
        /**
         * The configuration parameters for the identity provider. To view the required
         * parameters for a specific provider, refer to our
         * [developer documentation](https://developers.cloudflare.com/cloudflare-one/identity/idp-integration/).
         */
        config: AccessOkta.Config;
        /**
         * The name of the identity provider, shown to users on the login page.
         */
        name: string;
        /**
         * The type of identity provider. To determine the value for a specific provider,
         * refer to our
         * [developer documentation](https://developers.cloudflare.com/cloudflare-one/identity/idp-integration/).
         */
        type: IdentityProvidersAPI.IdentityProviderType;
        /**
         * UUID
         */
        id?: string;
        /**
         * The configuration settings for enabling a System for Cross-Domain Identity
         * Management (SCIM) with the identity provider.
         */
        scim_config?: IdentityProvidersAPI.IdentityProviderSCIMConfig;
    }
    namespace AccessOkta {
        /**
         * The configuration parameters for the identity provider. To view the required
         * parameters for a specific provider, refer to our
         * [developer documentation](https://developers.cloudflare.com/cloudflare-one/identity/idp-integration/).
         */
        interface Config {
            /**
             * Your okta authorization server id
             */
            authorization_server_id?: string;
            /**
             * Custom claims
             */
            claims?: Array<string>;
            /**
             * Your OAuth Client ID
             */
            client_id?: string;
            /**
             * Your OAuth Client Secret
             */
            client_secret?: string;
            /**
             * The claim name for email in the id_token response.
             */
            email_claim_name?: string;
            /**
             * Your okta account url
             */
            okta_account?: string;
        }
    }
    interface AccessOnelogin {
        /**
         * The configuration parameters for the identity provider. To view the required
         * parameters for a specific provider, refer to our
         * [developer documentation](https://developers.cloudflare.com/cloudflare-one/identity/idp-integration/).
         */
        config: AccessOnelogin.Config;
        /**
         * The name of the identity provider, shown to users on the login page.
         */
        name: string;
        /**
         * The type of identity provider. To determine the value for a specific provider,
         * refer to our
         * [developer documentation](https://developers.cloudflare.com/cloudflare-one/identity/idp-integration/).
         */
        type: IdentityProvidersAPI.IdentityProviderType;
        /**
         * UUID
         */
        id?: string;
        /**
         * The configuration settings for enabling a System for Cross-Domain Identity
         * Management (SCIM) with the identity provider.
         */
        scim_config?: IdentityProvidersAPI.IdentityProviderSCIMConfig;
    }
    namespace AccessOnelogin {
        /**
         * The configuration parameters for the identity provider. To view the required
         * parameters for a specific provider, refer to our
         * [developer documentation](https://developers.cloudflare.com/cloudflare-one/identity/idp-integration/).
         */
        interface Config {
            /**
             * Custom claims
             */
            claims?: Array<string>;
            /**
             * Your OAuth Client ID
             */
            client_id?: string;
            /**
             * Your OAuth Client Secret
             */
            client_secret?: string;
            /**
             * The claim name for email in the id_token response.
             */
            email_claim_name?: string;
            /**
             * Your OneLogin account url
             */
            onelogin_account?: string;
        }
    }
    interface AccessPingone {
        /**
         * The configuration parameters for the identity provider. To view the required
         * parameters for a specific provider, refer to our
         * [developer documentation](https://developers.cloudflare.com/cloudflare-one/identity/idp-integration/).
         */
        config: AccessPingone.Config;
        /**
         * The name of the identity provider, shown to users on the login page.
         */
        name: string;
        /**
         * The type of identity provider. To determine the value for a specific provider,
         * refer to our
         * [developer documentation](https://developers.cloudflare.com/cloudflare-one/identity/idp-integration/).
         */
        type: IdentityProvidersAPI.IdentityProviderType;
        /**
         * UUID
         */
        id?: string;
        /**
         * The configuration settings for enabling a System for Cross-Domain Identity
         * Management (SCIM) with the identity provider.
         */
        scim_config?: IdentityProvidersAPI.IdentityProviderSCIMConfig;
    }
    namespace AccessPingone {
        /**
         * The configuration parameters for the identity provider. To view the required
         * parameters for a specific provider, refer to our
         * [developer documentation](https://developers.cloudflare.com/cloudflare-one/identity/idp-integration/).
         */
        interface Config {
            /**
             * Custom claims
             */
            claims?: Array<string>;
            /**
             * Your OAuth Client ID
             */
            client_id?: string;
            /**
             * Your OAuth Client Secret
             */
            client_secret?: string;
            /**
             * The claim name for email in the id_token response.
             */
            email_claim_name?: string;
            /**
             * Your PingOne environment identifier
             */
            ping_env_id?: string;
        }
    }
    interface AccessSAML {
        /**
         * The configuration parameters for the identity provider. To view the required
         * parameters for a specific provider, refer to our
         * [developer documentation](https://developers.cloudflare.com/cloudflare-one/identity/idp-integration/).
         */
        config: AccessSAML.Config;
        /**
         * The name of the identity provider, shown to users on the login page.
         */
        name: string;
        /**
         * The type of identity provider. To determine the value for a specific provider,
         * refer to our
         * [developer documentation](https://developers.cloudflare.com/cloudflare-one/identity/idp-integration/).
         */
        type: IdentityProvidersAPI.IdentityProviderType;
        /**
         * UUID
         */
        id?: string;
        /**
         * The configuration settings for enabling a System for Cross-Domain Identity
         * Management (SCIM) with the identity provider.
         */
        scim_config?: IdentityProvidersAPI.IdentityProviderSCIMConfig;
    }
    namespace AccessSAML {
        /**
         * The configuration parameters for the identity provider. To view the required
         * parameters for a specific provider, refer to our
         * [developer documentation](https://developers.cloudflare.com/cloudflare-one/identity/idp-integration/).
         */
        interface Config {
            /**
             * A list of SAML attribute names that will be added to your signed JWT token and
             * can be used in SAML policy rules.
             */
            attributes?: Array<string>;
            /**
             * The attribute name for email in the SAML response.
             */
            email_attribute_name?: string;
            /**
             * Add a list of attribute names that will be returned in the response header from
             * the Access callback.
             */
            header_attributes?: Array<Config.HeaderAttribute>;
            /**
             * X509 certificate to verify the signature in the SAML authentication response
             */
            idp_public_certs?: Array<string>;
            /**
             * IdP Entity ID or Issuer URL
             */
            issuer_url?: string;
            /**
             * Sign the SAML authentication request with Access credentials. To verify the
             * signature, use the public key from the Access certs endpoints.
             */
            sign_request?: boolean;
            /**
             * URL to send the SAML authentication requests to
             */
            sso_target_url?: string;
        }
        namespace Config {
            interface HeaderAttribute {
                /**
                 * attribute name from the IDP
                 */
                attribute_name?: string;
                /**
                 * header that will be added on the request to the origin
                 */
                header_name?: string;
            }
        }
    }
    interface AccessYandex {
        /**
         * The configuration parameters for the identity provider. To view the required
         * parameters for a specific provider, refer to our
         * [developer documentation](https://developers.cloudflare.com/cloudflare-one/identity/idp-integration/).
         */
        config: IdentityProvidersAPI.GenericOAuthConfig;
        /**
         * The name of the identity provider, shown to users on the login page.
         */
        name: string;
        /**
         * The type of identity provider. To determine the value for a specific provider,
         * refer to our
         * [developer documentation](https://developers.cloudflare.com/cloudflare-one/identity/idp-integration/).
         */
        type: IdentityProvidersAPI.IdentityProviderType;
        /**
         * UUID
         */
        id?: string;
        /**
         * The configuration settings for enabling a System for Cross-Domain Identity
         * Management (SCIM) with the identity provider.
         */
        scim_config?: IdentityProvidersAPI.IdentityProviderSCIMConfig;
    }
    interface AccessOnetimepin {
        /**
         * The configuration parameters for the identity provider. To view the required
         * parameters for a specific provider, refer to our
         * [developer documentation](https://developers.cloudflare.com/cloudflare-one/identity/idp-integration/).
         */
        config: AccessOnetimepin.Config;
        /**
         * The name of the identity provider, shown to users on the login page.
         */
        name: string;
        /**
         * The type of identity provider. To determine the value for a specific provider,
         * refer to our
         * [developer documentation](https://developers.cloudflare.com/cloudflare-one/identity/idp-integration/).
         */
        type: IdentityProvidersAPI.IdentityProviderType;
        /**
         * UUID
         */
        id?: string;
        /**
         * The configuration settings for enabling a System for Cross-Domain Identity
         * Management (SCIM) with the identity provider.
         */
        scim_config?: IdentityProvidersAPI.IdentityProviderSCIMConfig;
    }
    namespace AccessOnetimepin {
        /**
         * The configuration parameters for the identity provider. To view the required
         * parameters for a specific provider, refer to our
         * [developer documentation](https://developers.cloudflare.com/cloudflare-one/identity/idp-integration/).
         */
        interface Config {
            redirect_url?: string;
        }
    }
}
export type IdentityProviderParam = AzureADParam | IdentityProviderParam.AccessCentrify | IdentityProviderParam.AccessFacebook | IdentityProviderParam.AccessGitHub | IdentityProviderParam.AccessGoogle | IdentityProviderParam.AccessGoogleApps | IdentityProviderParam.AccessLinkedin | IdentityProviderParam.AccessOIDC | IdentityProviderParam.AccessOkta | IdentityProviderParam.AccessOnelogin | IdentityProviderParam.AccessPingone | IdentityProviderParam.AccessSAML | IdentityProviderParam.AccessYandex | IdentityProviderParam.AccessOnetimepin;
export declare namespace IdentityProviderParam {
    interface AccessCentrify {
        /**
         * The configuration parameters for the identity provider. To view the required
         * parameters for a specific provider, refer to our
         * [developer documentation](https://developers.cloudflare.com/cloudflare-one/identity/idp-integration/).
         */
        config: AccessCentrify.Config;
        /**
         * The name of the identity provider, shown to users on the login page.
         */
        name: string;
        /**
         * The type of identity provider. To determine the value for a specific provider,
         * refer to our
         * [developer documentation](https://developers.cloudflare.com/cloudflare-one/identity/idp-integration/).
         */
        type: IdentityProvidersAPI.IdentityProviderTypeParam;
        /**
         * The configuration settings for enabling a System for Cross-Domain Identity
         * Management (SCIM) with the identity provider.
         */
        scim_config?: IdentityProvidersAPI.IdentityProviderSCIMConfigParam;
    }
    namespace AccessCentrify {
        /**
         * The configuration parameters for the identity provider. To view the required
         * parameters for a specific provider, refer to our
         * [developer documentation](https://developers.cloudflare.com/cloudflare-one/identity/idp-integration/).
         */
        interface Config {
            /**
             * Your centrify account url
             */
            centrify_account?: string;
            /**
             * Your centrify app id
             */
            centrify_app_id?: string;
            /**
             * Custom claims
             */
            claims?: Array<string>;
            /**
             * Your OAuth Client ID
             */
            client_id?: string;
            /**
             * Your OAuth Client Secret
             */
            client_secret?: string;
            /**
             * The claim name for email in the id_token response.
             */
            email_claim_name?: string;
        }
    }
    interface AccessFacebook {
        /**
         * The configuration parameters for the identity provider. To view the required
         * parameters for a specific provider, refer to our
         * [developer documentation](https://developers.cloudflare.com/cloudflare-one/identity/idp-integration/).
         */
        config: IdentityProvidersAPI.GenericOAuthConfigParam;
        /**
         * The name of the identity provider, shown to users on the login page.
         */
        name: string;
        /**
         * The type of identity provider. To determine the value for a specific provider,
         * refer to our
         * [developer documentation](https://developers.cloudflare.com/cloudflare-one/identity/idp-integration/).
         */
        type: IdentityProvidersAPI.IdentityProviderTypeParam;
        /**
         * The configuration settings for enabling a System for Cross-Domain Identity
         * Management (SCIM) with the identity provider.
         */
        scim_config?: IdentityProvidersAPI.IdentityProviderSCIMConfigParam;
    }
    interface AccessGitHub {
        /**
         * The configuration parameters for the identity provider. To view the required
         * parameters for a specific provider, refer to our
         * [developer documentation](https://developers.cloudflare.com/cloudflare-one/identity/idp-integration/).
         */
        config: IdentityProvidersAPI.GenericOAuthConfigParam;
        /**
         * The name of the identity provider, shown to users on the login page.
         */
        name: string;
        /**
         * The type of identity provider. To determine the value for a specific provider,
         * refer to our
         * [developer documentation](https://developers.cloudflare.com/cloudflare-one/identity/idp-integration/).
         */
        type: IdentityProvidersAPI.IdentityProviderTypeParam;
        /**
         * The configuration settings for enabling a System for Cross-Domain Identity
         * Management (SCIM) with the identity provider.
         */
        scim_config?: IdentityProvidersAPI.IdentityProviderSCIMConfigParam;
    }
    interface AccessGoogle {
        /**
         * The configuration parameters for the identity provider. To view the required
         * parameters for a specific provider, refer to our
         * [developer documentation](https://developers.cloudflare.com/cloudflare-one/identity/idp-integration/).
         */
        config: AccessGoogle.Config;
        /**
         * The name of the identity provider, shown to users on the login page.
         */
        name: string;
        /**
         * The type of identity provider. To determine the value for a specific provider,
         * refer to our
         * [developer documentation](https://developers.cloudflare.com/cloudflare-one/identity/idp-integration/).
         */
        type: IdentityProvidersAPI.IdentityProviderTypeParam;
        /**
         * The configuration settings for enabling a System for Cross-Domain Identity
         * Management (SCIM) with the identity provider.
         */
        scim_config?: IdentityProvidersAPI.IdentityProviderSCIMConfigParam;
    }
    namespace AccessGoogle {
        /**
         * The configuration parameters for the identity provider. To view the required
         * parameters for a specific provider, refer to our
         * [developer documentation](https://developers.cloudflare.com/cloudflare-one/identity/idp-integration/).
         */
        interface Config {
            /**
             * Custom claims
             */
            claims?: Array<string>;
            /**
             * Your OAuth Client ID
             */
            client_id?: string;
            /**
             * Your OAuth Client Secret
             */
            client_secret?: string;
            /**
             * The claim name for email in the id_token response.
             */
            email_claim_name?: string;
        }
    }
    interface AccessGoogleApps {
        /**
         * The configuration parameters for the identity provider. To view the required
         * parameters for a specific provider, refer to our
         * [developer documentation](https://developers.cloudflare.com/cloudflare-one/identity/idp-integration/).
         */
        config: AccessGoogleApps.Config;
        /**
         * The name of the identity provider, shown to users on the login page.
         */
        name: string;
        /**
         * The type of identity provider. To determine the value for a specific provider,
         * refer to our
         * [developer documentation](https://developers.cloudflare.com/cloudflare-one/identity/idp-integration/).
         */
        type: IdentityProvidersAPI.IdentityProviderTypeParam;
        /**
         * The configuration settings for enabling a System for Cross-Domain Identity
         * Management (SCIM) with the identity provider.
         */
        scim_config?: IdentityProvidersAPI.IdentityProviderSCIMConfigParam;
    }
    namespace AccessGoogleApps {
        /**
         * The configuration parameters for the identity provider. To view the required
         * parameters for a specific provider, refer to our
         * [developer documentation](https://developers.cloudflare.com/cloudflare-one/identity/idp-integration/).
         */
        interface Config {
            /**
             * Your companies TLD
             */
            apps_domain?: string;
            /**
             * Custom claims
             */
            claims?: Array<string>;
            /**
             * Your OAuth Client ID
             */
            client_id?: string;
            /**
             * Your OAuth Client Secret
             */
            client_secret?: string;
            /**
             * The claim name for email in the id_token response.
             */
            email_claim_name?: string;
        }
    }
    interface AccessLinkedin {
        /**
         * The configuration parameters for the identity provider. To view the required
         * parameters for a specific provider, refer to our
         * [developer documentation](https://developers.cloudflare.com/cloudflare-one/identity/idp-integration/).
         */
        config: IdentityProvidersAPI.GenericOAuthConfigParam;
        /**
         * The name of the identity provider, shown to users on the login page.
         */
        name: string;
        /**
         * The type of identity provider. To determine the value for a specific provider,
         * refer to our
         * [developer documentation](https://developers.cloudflare.com/cloudflare-one/identity/idp-integration/).
         */
        type: IdentityProvidersAPI.IdentityProviderTypeParam;
        /**
         * The configuration settings for enabling a System for Cross-Domain Identity
         * Management (SCIM) with the identity provider.
         */
        scim_config?: IdentityProvidersAPI.IdentityProviderSCIMConfigParam;
    }
    interface AccessOIDC {
        /**
         * The configuration parameters for the identity provider. To view the required
         * parameters for a specific provider, refer to our
         * [developer documentation](https://developers.cloudflare.com/cloudflare-one/identity/idp-integration/).
         */
        config: AccessOIDC.Config;
        /**
         * The name of the identity provider, shown to users on the login page.
         */
        name: string;
        /**
         * The type of identity provider. To determine the value for a specific provider,
         * refer to our
         * [developer documentation](https://developers.cloudflare.com/cloudflare-one/identity/idp-integration/).
         */
        type: IdentityProvidersAPI.IdentityProviderTypeParam;
        /**
         * The configuration settings for enabling a System for Cross-Domain Identity
         * Management (SCIM) with the identity provider.
         */
        scim_config?: IdentityProvidersAPI.IdentityProviderSCIMConfigParam;
    }
    namespace AccessOIDC {
        /**
         * The configuration parameters for the identity provider. To view the required
         * parameters for a specific provider, refer to our
         * [developer documentation](https://developers.cloudflare.com/cloudflare-one/identity/idp-integration/).
         */
        interface Config {
            /**
             * The authorization_endpoint URL of your IdP
             */
            auth_url?: string;
            /**
             * The jwks_uri endpoint of your IdP to allow the IdP keys to sign the tokens
             */
            certs_url?: string;
            /**
             * Custom claims
             */
            claims?: Array<string>;
            /**
             * Your OAuth Client ID
             */
            client_id?: string;
            /**
             * Your OAuth Client Secret
             */
            client_secret?: string;
            /**
             * The claim name for email in the id_token response.
             */
            email_claim_name?: string;
            /**
             * Enable Proof Key for Code Exchange (PKCE)
             */
            pkce_enabled?: boolean;
            /**
             * OAuth scopes
             */
            scopes?: Array<string>;
            /**
             * The token_endpoint URL of your IdP
             */
            token_url?: string;
        }
    }
    interface AccessOkta {
        /**
         * The configuration parameters for the identity provider. To view the required
         * parameters for a specific provider, refer to our
         * [developer documentation](https://developers.cloudflare.com/cloudflare-one/identity/idp-integration/).
         */
        config: AccessOkta.Config;
        /**
         * The name of the identity provider, shown to users on the login page.
         */
        name: string;
        /**
         * The type of identity provider. To determine the value for a specific provider,
         * refer to our
         * [developer documentation](https://developers.cloudflare.com/cloudflare-one/identity/idp-integration/).
         */
        type: IdentityProvidersAPI.IdentityProviderTypeParam;
        /**
         * The configuration settings for enabling a System for Cross-Domain Identity
         * Management (SCIM) with the identity provider.
         */
        scim_config?: IdentityProvidersAPI.IdentityProviderSCIMConfigParam;
    }
    namespace AccessOkta {
        /**
         * The configuration parameters for the identity provider. To view the required
         * parameters for a specific provider, refer to our
         * [developer documentation](https://developers.cloudflare.com/cloudflare-one/identity/idp-integration/).
         */
        interface Config {
            /**
             * Your okta authorization server id
             */
            authorization_server_id?: string;
            /**
             * Custom claims
             */
            claims?: Array<string>;
            /**
             * Your OAuth Client ID
             */
            client_id?: string;
            /**
             * Your OAuth Client Secret
             */
            client_secret?: string;
            /**
             * The claim name for email in the id_token response.
             */
            email_claim_name?: string;
            /**
             * Your okta account url
             */
            okta_account?: string;
        }
    }
    interface AccessOnelogin {
        /**
         * The configuration parameters for the identity provider. To view the required
         * parameters for a specific provider, refer to our
         * [developer documentation](https://developers.cloudflare.com/cloudflare-one/identity/idp-integration/).
         */
        config: AccessOnelogin.Config;
        /**
         * The name of the identity provider, shown to users on the login page.
         */
        name: string;
        /**
         * The type of identity provider. To determine the value for a specific provider,
         * refer to our
         * [developer documentation](https://developers.cloudflare.com/cloudflare-one/identity/idp-integration/).
         */
        type: IdentityProvidersAPI.IdentityProviderTypeParam;
        /**
         * The configuration settings for enabling a System for Cross-Domain Identity
         * Management (SCIM) with the identity provider.
         */
        scim_config?: IdentityProvidersAPI.IdentityProviderSCIMConfigParam;
    }
    namespace AccessOnelogin {
        /**
         * The configuration parameters for the identity provider. To view the required
         * parameters for a specific provider, refer to our
         * [developer documentation](https://developers.cloudflare.com/cloudflare-one/identity/idp-integration/).
         */
        interface Config {
            /**
             * Custom claims
             */
            claims?: Array<string>;
            /**
             * Your OAuth Client ID
             */
            client_id?: string;
            /**
             * Your OAuth Client Secret
             */
            client_secret?: string;
            /**
             * The claim name for email in the id_token response.
             */
            email_claim_name?: string;
            /**
             * Your OneLogin account url
             */
            onelogin_account?: string;
        }
    }
    interface AccessPingone {
        /**
         * The configuration parameters for the identity provider. To view the required
         * parameters for a specific provider, refer to our
         * [developer documentation](https://developers.cloudflare.com/cloudflare-one/identity/idp-integration/).
         */
        config: AccessPingone.Config;
        /**
         * The name of the identity provider, shown to users on the login page.
         */
        name: string;
        /**
         * The type of identity provider. To determine the value for a specific provider,
         * refer to our
         * [developer documentation](https://developers.cloudflare.com/cloudflare-one/identity/idp-integration/).
         */
        type: IdentityProvidersAPI.IdentityProviderTypeParam;
        /**
         * The configuration settings for enabling a System for Cross-Domain Identity
         * Management (SCIM) with the identity provider.
         */
        scim_config?: IdentityProvidersAPI.IdentityProviderSCIMConfigParam;
    }
    namespace AccessPingone {
        /**
         * The configuration parameters for the identity provider. To view the required
         * parameters for a specific provider, refer to our
         * [developer documentation](https://developers.cloudflare.com/cloudflare-one/identity/idp-integration/).
         */
        interface Config {
            /**
             * Custom claims
             */
            claims?: Array<string>;
            /**
             * Your OAuth Client ID
             */
            client_id?: string;
            /**
             * Your OAuth Client Secret
             */
            client_secret?: string;
            /**
             * The claim name for email in the id_token response.
             */
            email_claim_name?: string;
            /**
             * Your PingOne environment identif