Identity Providers
List Access identity providers
Get an Access identity provider
Add an Access identity provider
Update an Access identity provider
Delete an Access identity provider
ModelsExpand Collapse
AzureAD = object { config, name, type, 2 more }
config: object { claims, client_id, client_secret, 5 more } The configuration parameters for the identity provider. To view the required parameters for a specific provider, refer to our developer documentation.
The configuration parameters for the identity provider. To view the required parameters for a specific provider, refer to our developer documentation.
Should Cloudflare try to load authentication contexts from your account
prompt: optional "login" or "select_account" or "none"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.
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.
The type of identity provider. To determine the value for a specific provider, refer to our developer documentation.
The configuration settings for enabling a System for Cross-Domain Identity Management (SCIM) with the identity provider.
IdentityProvider = AzureAD { config, name, type, 2 more } or object { config, name, type, 2 more } or object { config, name, type, 2 more } or 11 more
AzureAD = object { config, name, type, 2 more }
config: object { claims, client_id, client_secret, 5 more } The configuration parameters for the identity provider. To view the required parameters for a specific provider, refer to our developer documentation.
The configuration parameters for the identity provider. To view the required parameters for a specific provider, refer to our developer documentation.
Should Cloudflare try to load authentication contexts from your account
prompt: optional "login" or "select_account" or "none"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.
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.
The type of identity provider. To determine the value for a specific provider, refer to our developer documentation.
The configuration settings for enabling a System for Cross-Domain Identity Management (SCIM) with the identity provider.
AccessCentrify = object { config, name, type, 2 more }
config: object { centrify_account, centrify_app_id, claims, 3 more } The configuration parameters for the identity provider. To view the required parameters for a specific provider, refer to our developer documentation.
The configuration parameters for the identity provider. To view the required parameters for a specific provider, refer to our developer documentation.
The type of identity provider. To determine the value for a specific provider, refer to our developer documentation.
The configuration settings for enabling a System for Cross-Domain Identity Management (SCIM) with the identity provider.
AccessFacebook = object { config, name, type, 2 more }
The configuration parameters for the identity provider. To view the required parameters for a specific provider, refer to our developer documentation.
The type of identity provider. To determine the value for a specific provider, refer to our developer documentation.
The configuration settings for enabling a System for Cross-Domain Identity Management (SCIM) with the identity provider.
AccessGitHub = object { config, name, type, 2 more }
The configuration parameters for the identity provider. To view the required parameters for a specific provider, refer to our developer documentation.
The type of identity provider. To determine the value for a specific provider, refer to our developer documentation.
The configuration settings for enabling a System for Cross-Domain Identity Management (SCIM) with the identity provider.
AccessGoogle = object { config, name, type, 2 more }
config: object { claims, client_id, client_secret, email_claim_name } The configuration parameters for the identity provider. To view the required parameters for a specific provider, refer to our developer documentation.
The configuration parameters for the identity provider. To view the required parameters for a specific provider, refer to our developer documentation.
The type of identity provider. To determine the value for a specific provider, refer to our developer documentation.
The configuration settings for enabling a System for Cross-Domain Identity Management (SCIM) with the identity provider.
AccessGoogleApps = object { config, name, type, 2 more }
config: object { apps_domain, claims, client_id, 2 more } The configuration parameters for the identity provider. To view the required parameters for a specific provider, refer to our developer documentation.
The configuration parameters for the identity provider. To view the required parameters for a specific provider, refer to our developer documentation.
The type of identity provider. To determine the value for a specific provider, refer to our developer documentation.
The configuration settings for enabling a System for Cross-Domain Identity Management (SCIM) with the identity provider.
AccessLinkedin = object { config, name, type, 2 more }
The configuration parameters for the identity provider. To view the required parameters for a specific provider, refer to our developer documentation.
The type of identity provider. To determine the value for a specific provider, refer to our developer documentation.
The configuration settings for enabling a System for Cross-Domain Identity Management (SCIM) with the identity provider.
AccessOIDC = object { config, name, type, 2 more }
config: object { auth_url, certs_url, claims, 6 more } The configuration parameters for the identity provider. To view the required parameters for a specific provider, refer to our developer documentation.
The configuration parameters for the identity provider. To view the required parameters for a specific provider, refer to our developer documentation.
The type of identity provider. To determine the value for a specific provider, refer to our developer documentation.
The configuration settings for enabling a System for Cross-Domain Identity Management (SCIM) with the identity provider.
AccessOkta = object { config, name, type, 2 more }
config: object { authorization_server_id, claims, client_id, 3 more } The configuration parameters for the identity provider. To view the required parameters for a specific provider, refer to our developer documentation.
The configuration parameters for the identity provider. To view the required parameters for a specific provider, refer to our developer documentation.
The type of identity provider. To determine the value for a specific provider, refer to our developer documentation.
The configuration settings for enabling a System for Cross-Domain Identity Management (SCIM) with the identity provider.
AccessOnelogin = object { config, name, type, 2 more }
config: object { claims, client_id, client_secret, 2 more } The configuration parameters for the identity provider. To view the required parameters for a specific provider, refer to our developer documentation.
The configuration parameters for the identity provider. To view the required parameters for a specific provider, refer to our developer documentation.
The type of identity provider. To determine the value for a specific provider, refer to our developer documentation.
The configuration settings for enabling a System for Cross-Domain Identity Management (SCIM) with the identity provider.
AccessPingone = object { config, name, type, 2 more }
config: object { claims, client_id, client_secret, 2 more } The configuration parameters for the identity provider. To view the required parameters for a specific provider, refer to our developer documentation.
The configuration parameters for the identity provider. To view the required parameters for a specific provider, refer to our developer documentation.
The type of identity provider. To determine the value for a specific provider, refer to our developer documentation.
The configuration settings for enabling a System for Cross-Domain Identity Management (SCIM) with the identity provider.
AccessSAML = object { config, name, type, 2 more }
config: object { attributes, email_attribute_name, header_attributes, 4 more } The configuration parameters for the identity provider. To view the required parameters for a specific provider, refer to our developer documentation.
The configuration parameters for the identity provider. To view the required parameters for a specific provider, refer to our developer documentation.
A list of SAML attribute names that will be added to your signed JWT token and can be used in SAML policy rules.
header_attributes: optional array of object { attribute_name, header_name } Add a list of attribute names that will be returned in the response header from the Access callback.
Add a list of attribute names that will be returned in the response header from the Access callback.
X509 certificate to verify the signature in the SAML authentication response
The type of identity provider. To determine the value for a specific provider, refer to our developer documentation.
The configuration settings for enabling a System for Cross-Domain Identity Management (SCIM) with the identity provider.
AccessYandex = object { config, name, type, 2 more }
The configuration parameters for the identity provider. To view the required parameters for a specific provider, refer to our developer documentation.
The type of identity provider. To determine the value for a specific provider, refer to our developer documentation.
The configuration settings for enabling a System for Cross-Domain Identity Management (SCIM) with the identity provider.
AccessOnetimepin = object { config, name, type, 2 more }
config: object { redirect_url } The configuration parameters for the identity provider. To view the required parameters for a specific provider, refer to our developer documentation.
The configuration parameters for the identity provider. To view the required parameters for a specific provider, refer to our developer documentation.
The type of identity provider. To determine the value for a specific provider, refer to our developer documentation.
The configuration settings for enabling a System for Cross-Domain Identity Management (SCIM) with the identity provider.
IdentityProviderSCIMConfig = object { enabled, identity_update_behavior, scim_base_url, 3 more } The configuration settings for enabling a System for Cross-Domain Identity Management (SCIM) with the identity provider.
The configuration settings for enabling a System for Cross-Domain Identity Management (SCIM) with the identity provider.
identity_update_behavior: optional "automatic" or "reauth" or "no_action"Indicates how a SCIM event updates a user identity used for policy evaluation. Use "automatic" to automatically update a user's identity and augment it with fields from the SCIM user resource. Use "reauth" to force re-authentication on group membership updates, user identity update will only occur after successful re-authentication. With "reauth" identities will not contain fields from the SCIM user resource. With "no_action" identities will not be changed by SCIM updates in any way and users will not be prompted to reauthenticate.
Indicates how a SCIM event updates a user identity used for policy evaluation. Use "automatic" to automatically update a user's identity and augment it with fields from the SCIM user resource. Use "reauth" to force re-authentication on group membership updates, user identity update will only occur after successful re-authentication. With "reauth" identities will not contain fields from the SCIM user resource. With "no_action" identities will not be changed by SCIM updates in any way and users will not be prompted to reauthenticate.
A flag to remove a user's seat in Zero Trust when they have been deprovisioned in the Identity Provider. This cannot be enabled unless user_deprovision is also enabled.
IdentityProviderType = "onetimepin" or "azureAD" or "saml" or 11 moreThe type of identity provider. To determine the value for a specific provider, refer to our developer documentation.
The type of identity provider. To determine the value for a specific provider, refer to our developer documentation.
IdentityProviderListResponse = AzureAD { config, name, type, 2 more } or object { config, name, type, 2 more } or object { config, name, type, 2 more } or 10 more
AzureAD = object { config, name, type, 2 more }
config: object { claims, client_id, client_secret, 5 more } The configuration parameters for the identity provider. To view the required parameters for a specific provider, refer to our developer documentation.
The configuration parameters for the identity provider. To view the required parameters for a specific provider, refer to our developer documentation.
Should Cloudflare try to load authentication contexts from your account
prompt: optional "login" or "select_account" or "none"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.
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.
The type of identity provider. To determine the value for a specific provider, refer to our developer documentation.
The configuration settings for enabling a System for Cross-Domain Identity Management (SCIM) with the identity provider.
AccessCentrify = object { config, name, type, 2 more }
config: object { centrify_account, centrify_app_id, claims, 3 more } The configuration parameters for the identity provider. To view the required parameters for a specific provider, refer to our developer documentation.
The configuration parameters for the identity provider. To view the required parameters for a specific provider, refer to our developer documentation.
The type of identity provider. To determine the value for a specific provider, refer to our developer documentation.
The configuration settings for enabling a System for Cross-Domain Identity Management (SCIM) with the identity provider.
AccessFacebook = object { config, name, type, 2 more }
The configuration parameters for the identity provider. To view the required parameters for a specific provider, refer to our developer documentation.
The type of identity provider. To determine the value for a specific provider, refer to our developer documentation.
The configuration settings for enabling a System for Cross-Domain Identity Management (SCIM) with the identity provider.
AccessGitHub = object { config, name, type, 2 more }
The configuration parameters for the identity provider. To view the required parameters for a specific provider, refer to our developer documentation.
The type of identity provider. To determine the value for a specific provider, refer to our developer documentation.
The configuration settings for enabling a System for Cross-Domain Identity Management (SCIM) with the identity provider.
AccessGoogle = object { config, name, type, 2 more }
config: object { claims, client_id, client_secret, email_claim_name } The configuration parameters for the identity provider. To view the required parameters for a specific provider, refer to our developer documentation.
The configuration parameters for the identity provider. To view the required parameters for a specific provider, refer to our developer documentation.
The type of identity provider. To determine the value for a specific provider, refer to our developer documentation.
The configuration settings for enabling a System for Cross-Domain Identity Management (SCIM) with the identity provider.
AccessGoogleApps = object { config, name, type, 2 more }
config: object { apps_domain, claims, client_id, 2 more } The configuration parameters for the identity provider. To view the required parameters for a specific provider, refer to our developer documentation.
The configuration parameters for the identity provider. To view the required parameters for a specific provider, refer to our developer documentation.
The type of identity provider. To determine the value for a specific provider, refer to our developer documentation.
The configuration settings for enabling a System for Cross-Domain Identity Management (SCIM) with the identity provider.
AccessLinkedin = object { config, name, type, 2 more }
The configuration parameters for the identity provider. To view the required parameters for a specific provider, refer to our developer documentation.
The type of identity provider. To determine the value for a specific provider, refer to our developer documentation.
The configuration settings for enabling a System for Cross-Domain Identity Management (SCIM) with the identity provider.
AccessOIDC = object { config, name, type, 2 more }
config: object { auth_url, certs_url, claims, 6 more } The configuration parameters for the identity provider. To view the required parameters for a specific provider, refer to our developer documentation.
The configuration parameters for the identity provider. To view the required parameters for a specific provider, refer to our developer documentation.
The type of identity provider. To determine the value for a specific provider, refer to our developer documentation.
The configuration settings for enabling a System for Cross-Domain Identity Management (SCIM) with the identity provider.
AccessOkta = object { config, name, type, 2 more }
config: object { authorization_server_id, claims, client_id, 3 more } The configuration parameters for the identity provider. To view the required parameters for a specific provider, refer to our developer documentation.
The configuration parameters for the identity provider. To view the required parameters for a specific provider, refer to our developer documentation.
The type of identity provider. To determine the value for a specific provider, refer to our developer documentation.
The configuration settings for enabling a System for Cross-Domain Identity Management (SCIM) with the identity provider.
AccessOnelogin = object { config, name, type, 2 more }
config: object { claims, client_id, client_secret, 2 more } The configuration parameters for the identity provider. To view the required parameters for a specific provider, refer to our developer documentation.
The configuration parameters for the identity provider. To view the required parameters for a specific provider, refer to our developer documentation.
The type of identity provider. To determine the value for a specific provider, refer to our developer documentation.
The configuration settings for enabling a System for Cross-Domain Identity Management (SCIM) with the identity provider.
AccessPingone = object { config, name, type, 2 more }
config: object { claims, client_id, client_secret, 2 more } The configuration parameters for the identity provider. To view the required parameters for a specific provider, refer to our developer documentation.
The configuration parameters for the identity provider. To view the required parameters for a specific provider, refer to our developer documentation.
The type of identity provider. To determine the value for a specific provider, refer to our developer documentation.
The configuration settings for enabling a System for Cross-Domain Identity Management (SCIM) with the identity provider.
AccessSAML = object { config, name, type, 2 more }
config: object { attributes, email_attribute_name, header_attributes, 4 more } The configuration parameters for the identity provider. To view the required parameters for a specific provider, refer to our developer documentation.
The configuration parameters for the identity provider. To view the required parameters for a specific provider, refer to our developer documentation.
A list of SAML attribute names that will be added to your signed JWT token and can be used in SAML policy rules.
header_attributes: optional array of object { attribute_name, header_name } Add a list of attribute names that will be returned in the response header from the Access callback.
Add a list of attribute names that will be returned in the response header from the Access callback.
X509 certificate to verify the signature in the SAML authentication response
The type of identity provider. To determine the value for a specific provider, refer to our developer documentation.
The configuration settings for enabling a System for Cross-Domain Identity Management (SCIM) with the identity provider.
AccessYandex = object { config, name, type, 2 more }
The configuration parameters for the identity provider. To view the required parameters for a specific provider, refer to our developer documentation.
The type of identity provider. To determine the value for a specific provider, refer to our developer documentation.
The configuration settings for enabling a System for Cross-Domain Identity Management (SCIM) with the identity provider.