|
| 1 | +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. |
| 2 | + |
| 3 | +from __future__ import annotations |
| 4 | + |
| 5 | +from typing import List |
| 6 | +from typing_extensions import Literal, Required, TypedDict |
| 7 | + |
| 8 | +from .identity_provider_type import IdentityProviderType |
| 9 | +from .identity_provider_scim_config_param import IdentityProviderSCIMConfigParam |
| 10 | + |
| 11 | +__all__ = ["AzureADParam", "Config"] |
| 12 | + |
| 13 | + |
| 14 | +class Config(TypedDict, total=False): |
| 15 | + claims: List[str] |
| 16 | + """Custom claims""" |
| 17 | + |
| 18 | + client_id: str |
| 19 | + """Your OAuth Client ID""" |
| 20 | + |
| 21 | + client_secret: str |
| 22 | + """Your OAuth Client Secret""" |
| 23 | + |
| 24 | + conditional_access_enabled: bool |
| 25 | + """Should Cloudflare try to load authentication contexts from your account""" |
| 26 | + |
| 27 | + directory_id: str |
| 28 | + """Your Azure directory uuid""" |
| 29 | + |
| 30 | + email_claim_name: str |
| 31 | + """The claim name for email in the id_token response.""" |
| 32 | + |
| 33 | + prompt: Literal["login", "select_account", "none"] |
| 34 | + """Indicates the type of user interaction that is required. |
| 35 | +
|
| 36 | + prompt=login forces the user to enter their credentials on that request, |
| 37 | + negating single-sign on. prompt=none is the opposite. It ensures that the user |
| 38 | + isn't presented with any interactive prompt. If the request can't be completed |
| 39 | + silently by using single-sign on, the Microsoft identity platform returns an |
| 40 | + interaction_required error. prompt=select_account interrupts single sign-on |
| 41 | + providing account selection experience listing all the accounts either in |
| 42 | + session or any remembered account or an option to choose to use a different |
| 43 | + account altogether. |
| 44 | + """ |
| 45 | + |
| 46 | + support_groups: bool |
| 47 | + """Should Cloudflare try to load groups from your account""" |
| 48 | + |
| 49 | + |
| 50 | +class AzureADParam(TypedDict, total=False): |
| 51 | + config: Required[Config] |
| 52 | + """The configuration parameters for the identity provider. |
| 53 | +
|
| 54 | + To view the required parameters for a specific provider, refer to our |
| 55 | + [developer documentation](https://developers.cloudflare.com/cloudflare-one/identity/idp-integration/). |
| 56 | + """ |
| 57 | + |
| 58 | + name: Required[str] |
| 59 | + """The name of the identity provider, shown to users on the login page.""" |
| 60 | + |
| 61 | + type: Required[IdentityProviderType] |
| 62 | + """The type of identity provider. |
| 63 | +
|
| 64 | + To determine the value for a specific provider, refer to our |
| 65 | + [developer documentation](https://developers.cloudflare.com/cloudflare-one/identity/idp-integration/). |
| 66 | + """ |
| 67 | + |
| 68 | + scim_config: IdentityProviderSCIMConfigParam |
| 69 | + """ |
| 70 | + The configuration settings for enabling a System for Cross-Domain Identity |
| 71 | + Management (SCIM) with the identity provider. |
| 72 | + """ |
0 commit comments