{"Les scopes définissent les autorisations et les niveaux d’accès des requêtes d’API et des jetons d’authentification."}
true si cette application peut être utilisée pour
effectuer des requêtes d’authentification inter-origine,
false sinon, si l’authentification inter-origine est
désactivée
type: boolean
cross_origin_loc:
description: >-
URL de l’emplacement sur votre site où s’effectue la vérification
inter-origine pour le flux d’authentification inter-origine lorsque
vous effectuez l’authentification sur votre propre domaine plutôt
que sur la page de connexion hébergée par Auth0.
format: url-or-null
type:
- string
- 'null'
custom_login_page:
description: Le contenu (HTML, CSS, JS) de la page de connexion personnalisée
type: string
custom_login_page_on:
description: >-
true si la page de connexion personnalisée doit être
utilisée, false sinon.
type: boolean
custom_login_page_preview:
type: string
default_organization:
$ref: '#/components/schemas/ClientDefaultOrganization'
description:
description: "Description libre de l’objectif de l’application. (Longueur maximale\_: 140 caractères)"
maxLength: 140
type: string
encryption_key:
$ref: '#/components/schemas/ClientEncryptionKey'
description: La clé de chiffrement de l’application
express_configuration:
$ref: '#/components/schemas/ExpressConfigurationOrNull'
fedcm_login:
$ref: '#/components/schemas/FedCMLoginPatch'
x-release-lifecycle: EA
form_template:
description: Modèle de formulaire pour le protocole WS-Federation
type: string
grant_types:
description: >-
Ensemble de types d’octroi que l’application est autorisée à
utiliser. Peut inclure `authorization_code`, `implicit`,
`refresh_token`, `client_credentials`, `password`,
`http://auth0.com/oauth/grant-type/password-realm`,
`http://auth0.com/oauth/grant-type/mfa-oob`,
`http://auth0.com/oauth/grant-type/mfa-otp`,
`http://auth0.com/oauth/grant-type/mfa-recovery-code`,
`urn:openid:params:grant-type:ciba`,
`urn:ietf:params:oauth:grant-type:device_code` et
`urn:auth0:params:oauth:grant-type:token-exchange:federated-connection-access-token`.
items:
minLength: 1
type: string
type: array
initiate_login_uri:
description: URI d’initialisation de la connexion, doit utiliser HTTPS
format: absolute-https-uri-with-placeholders-or-empty
type: string
is_first_party:
default: true
description: Indique s’il s’agit ou non d’une application propriétaire
type: boolean
is_token_endpoint_ip_header_trusted:
default: false
description: >-
Si la valeur est true, l’IP indiquée dans l’en-tête
`auth0-forwarded-for` est considérée comme étant l’IP de
l’utilisateur final pour la protection contre les attaques par force
brute sur le point de terminaison de jeton.
type: boolean
jwt_configuration:
$ref: '#/components/schemas/ClientJwtConfiguration'
description: Objet contenant les paramètres liés à la création des JWT
logo_uri:
description: "L’URL du logo de l’application (taille recommandée\_: 150x150)"
format: absolute-uri-or-empty
type: string
mobile:
$ref: '#/components/schemas/ClientMobile'
description: Configuration liée aux applications mobiles natives
my_organization_configuration:
$ref: '#/components/schemas/ClientMyOrganizationPatchConfiguration'
x-release-lifecycle: EA
name:
description: "Le nom de l’application. Doit contenir au moins un caractère. Les caractères «\_<\_» et «\_>\_» ne sont pas autorisés."
pattern: ^[^<>]+$
type: string
native_social_login:
$ref: '#/components/schemas/NativeSocialLoginPatch'
oidc_backchannel_logout:
$ref: '#/components/schemas/ClientOIDCBackchannelLogoutSettings'
description: >-
Configuration de la déconnexion OIDC par canal arrière (obsolète,
remplacée par oidc_logout)
x-release-lifecycle: deprecated
oidc_conformant:
default: false
description: >-
Indique si cette application respecte strictement les spécifications
OIDC
type: boolean
oidc_logout:
$ref: '#/components/schemas/ClientOIDCBackchannelLogoutSettings'
organization_discovery_methods:
description: >-
Définit les méthodes disponibles pour la découverte de
l’organisation pendant le `pre_login_prompt`. Les utilisateurs
peuvent découvrir leur organisation au moyen de `email`, de
`organization_name` ou des deux.
items:
$ref: '#/components/schemas/ClientOrganizationDiscoveryEnum'
minItems: 1
type:
- array
- 'null'
x-release-lifecycle: EA
organization_require_behavior:
$ref: '#/components/schemas/ClientOrganizationRequireBehaviorPatchEnum'
organization_usage:
$ref: '#/components/schemas/ClientOrganizationUsagePatchEnum'
par_request_expiry:
description: >-
Spécifie la durée de validité, en secondes, d’un URI de requête
d’autorisation poussée
maximum: 600
minimum: 10
type:
- integer
- 'null'
redirection_policy:
$ref: '#/components/schemas/ClientRedirectionPolicyEnum'
x-release-lifecycle: GA
refresh_token:
$ref: '#/components/schemas/ClientRefreshTokenConfiguration'
require_proof_of_possession:
default: false
description: >-
Rend obligatoire l’utilisation de la preuve de possession pour cette
application
type: boolean
require_pushed_authorization_requests:
default: false
description: >-
Rend obligatoire l’utilisation des requêtes d’autorisation poussées
pour cette application
type: boolean
session_transfer:
$ref: '#/components/schemas/ClientSessionTransferConfiguration'
signed_request_object:
$ref: '#/components/schemas/ClientSignedRequestObjectWithCredentialId'
skip_non_verifiable_callback_uri_confirmation_prompt:
description: >-
Détermine si une invite de confirmation s’affiche pendant les flux
de connexion lorsque l’URI de redirection utilise des URI de rappel
non vérifiables (par exemple, un schéma d’URI personnalisé comme
`myapp://` ou `localhost`).
Si cette valeur est définie sur true, aucune invite de confirmation
ne s’affiche. Nous recommandons de la définir sur false pour mieux
vous protéger contre les applications malveillantes.
Consultez
https://auth0.com/docs/secure/security-guidance/measures-against-app-impersonation
pour en savoir plus.
type:
- boolean
- 'null'
sso:
description: "true pour utiliser Auth0 au lieu de l’IdP afin d’effectuer l’authentification unique, false sinon (par défaut\_: false)"
type: boolean
sso_disabled:
description: "true pour désactiver l’authentification unique, false sinon (par défaut\_: false)"
type: boolean
third_party_security_mode:
$ref: '#/components/schemas/ClientThirdPartySecurityModeEnum'
x-release-lifecycle: GA
token_endpoint_auth_method:
$ref: '#/components/schemas/ClientTokenEndpointAuthMethodOrNullEnum'
token_exchange:
$ref: '#/components/schemas/ClientTokenExchangeConfigurationOrNull'
x-release-lifecycle: GA
token_quota:
$ref: '#/components/schemas/UpdateTokenQuota'
x-release-lifecycle: EA
web_origins:
description: >-
Ensemble d’URL représentant les origines Web valides à utiliser avec
le mode de réponse web_message
items:
format: url-with-placeholders
type: string
type: array
type: object
UpdateClientResponseContent:
additionalProperties: true
properties:
addons:
$ref: '#/components/schemas/ClientAddons'
allowed_clients:
description: >-
Liste des applications et des id d’API autorisés à effectuer des
requêtes de delegation. Une valeur vide signifie que toutes vos
applications sont autorisées.
items:
type: string
type: array
allowed_logout_urls:
description: >-
Liste d’URL séparées par des virgules vers lesquelles il est
possible de rediriger après la déconnexion d’Auth0. Les caractères
génériques sont autorisés pour les sous-domaines.
items:
type: string
type: array
allowed_origins:
description: "Liste d’URL séparées par des virgules autorisées à envoyer des requêtes JavaScript à l’API Auth0 (généralement utilisée avec CORS). Par défaut, toutes vos URL de rappel seront autorisées. Ce champ vous permet d’indiquer d’autres origines au besoin. Vous pouvez aussi utiliser des caractères génériques au niveau du sous-domaine (p.\_ex., https://*.contoso.com). Les chaînes de requête et les informations de hash ne sont pas prises en compte lors de la validation de ces URL."
items:
type: string
type: array
app_type:
$ref: '#/components/schemas/ClientAppTypeEnum'
async_approval_notification_channels:
$ref: >-
#/components/schemas/ClientAsyncApprovalNotificationsChannelsAPIPostConfiguration
callbacks:
description: >-
Liste d’URL séparées par des virgules et sur liste blanche qu’Auth0
peut utiliser comme URL de rappel vers l’application après
l’authentification.
items:
type: string
type: array
client_aliases:
description: >-
Liste des audiences/realms pour le protocole SAML. Utilisée par
l’addon wsfed.
items:
type: string
type: array
client_authentication_methods:
$ref: '#/components/schemas/ClientAuthenticationMethod'
client_id:
default: AaiyAPdpYdesoKnqjj8HJqRn4T5titww
description: ID de cette application.
type: string
client_metadata:
$ref: '#/components/schemas/ClientMetadata'
client_secret:
default: MG_TNT2ver-SylNat-_VeMmd-4m0Waba0jr1troztBniSChEw0glxEmgEi2Kw40H
description: Secret client (que vous ne devez pas rendre public).
type: string
compliance_level:
$ref: '#/components/schemas/ClientComplianceLevelEnum'
cross_origin_authentication:
description: >-
Indique si cette application peut être utilisée pour effectuer des
requêtes d’authentification inter-origine (true) ou si elle n’est
pas autorisée à effectuer ce type de requêtes (false).
type: boolean
cross_origin_loc:
description: >-
URL de l’emplacement de votre site où s’effectue la vérification
inter-origine pour le flux d’authentification inter-origine lorsque
l’authentification est effectuée sur votre propre domaine plutôt que
sur la page de connexion hébergée par Auth0.
format: url
type: string
custom_login_page:
default: ''
description: Contenu (HTML, CSS, JS) de la page de connexion personnalisée.
type: string
custom_login_page_on:
default: true
description: >-
Indique si une page de connexion personnalisée doit être utilisée
(true) ou si la page de connexion par défaut fournie doit l’être
(false).
type: boolean
custom_login_page_preview:
default: ''
description: >-
Contenu (HTML, CSS, JS) de la page de connexion personnalisée.
(Utilisé dans les aperçus)
type: string
default_organization:
$ref: '#/components/schemas/ClientDefaultOrganization'
description:
default: ''
description: "Description libre de cette application (longueur maximale\_: 140 caractères)."
type: string
encryption_key:
$ref: '#/components/schemas/ClientEncryptionKey'
express_configuration:
$ref: '#/components/schemas/ExpressConfiguration'
external_client_id:
description: >-
Un autre identifiant d’application à utiliser pendant les flux
d’autorisation. Prend uniquement en charge les identifiants
d’application basés sur CIMD.
format: absolute-https-uri-or-empty
type: string
external_metadata_created_by:
$ref: '#/components/schemas/ClientExternalMetadataCreatedByEnum'
external_metadata_type:
$ref: '#/components/schemas/ClientExternalMetadataTypeEnum'
fedcm_login:
$ref: '#/components/schemas/FedCMLogin'
x-release-lifecycle: EA
form_template:
default: ''
description: Modèle de formulaire HTML à utiliser pour WS-Federation.
type: string
global:
default: false
description: "Indique s’il s’agit de votre application globale «\_All Applications\_», qui représente les anciens paramètres du locataire (true), ou d’une application standard (false)."
type: boolean
grant_types:
description: >-
Liste des types d’octroi pris en charge pour cette application. Peut
inclure `authorization_code`, `implicit`, `refresh_token`,
`client_credentials`, `password`,
`http://auth0.com/oauth/grant-type/password-realm`,
`http://auth0.com/oauth/grant-type/mfa-oob`,
`http://auth0.com/oauth/grant-type/mfa-otp`,
`http://auth0.com/oauth/grant-type/mfa-recovery-code`,
`urn:openid:params:grant-type:ciba`,
`urn:ietf:params:oauth:grant-type:device_code` et
`urn:auth0:params:oauth:grant-type:token-exchange:federated-connection-access-token`.
items:
type: string
type: array
initiate_login_uri:
description: URI d’initialisation de connexion; doit utiliser HTTPS
format: absolute-https-uri-with-placeholders-or-empty
type: string
is_first_party:
default: false
description: >-
Indique si cette application est une application de première partie
(true) ou non (false).
type: boolean
is_token_endpoint_ip_header_trusted:
default: false
description: >-
Si la valeur est true, l’adresse IP indiquée dans l’en-tête
`auth0-forwarded-for` est considérée comme étant celle de
l’utilisateur final pour la protection contre les attaques par force
brute au point de terminaison de jeton.
type: boolean
jwks_uri:
description: >-
URL de l’ensemble de clés JSON Web (JWKS) contenant les clés
publiques utilisées pour l’authentification private_key_jwt.
Présente uniquement pour les clients CIMD utilisant
l’authentification private_key_jwt.
format: absolute-https-uri-or-empty
type: string
jwt_configuration:
$ref: '#/components/schemas/ClientJwtConfiguration'
logo_uri:
description: >-
URL du logo à afficher pour cette application. La taille recommandée
est de 150 × 150 pixels.
type: string
mobile:
$ref: '#/components/schemas/ClientMobile'
my_organization_configuration:
$ref: '#/components/schemas/ClientMyOrganizationResponseConfiguration'
x-release-lifecycle: EA
name:
default: My application
description: "Nom de cette application (longueur minimale\_: 1 caractère; n’autorise pas `<` ni `>`)."
type: string
native_social_login:
$ref: '#/components/schemas/NativeSocialLogin'
oidc_conformant:
default: false
description: >-
Indique si cette application est conforme aux spécifications
OIDC strictes (true) ou si elle utilise des fonctionnalités
anciennes (false).
type: boolean
oidc_logout:
$ref: '#/components/schemas/ClientOIDCBackchannelLogoutSettings'
organization_discovery_methods:
description: >-
Définit les méthodes disponibles pour la découverte de
l’organisation pendant le `pre_login_prompt`. Les utilisateurs
peuvent découvrir leur organisation à l’aide de `email`, de
`organization_name` ou des deux.
items:
$ref: '#/components/schemas/ClientOrganizationDiscoveryEnum'
minItems: 1
type: array
x-release-lifecycle: EA
organization_require_behavior:
$ref: '#/components/schemas/ClientOrganizationRequireBehaviorEnum'
organization_usage:
$ref: '#/components/schemas/ClientOrganizationUsageEnum'
par_request_expiry:
description: >-
Indique pendant combien de temps, en secondes, une URI de requête
d’autorisation poussée reste valide
maximum: 600
minimum: 10
type:
- integer
- 'null'
redirection_policy:
$ref: '#/components/schemas/ClientRedirectionPolicyEnum'
x-release-lifecycle: GA
refresh_token:
$ref: '#/components/schemas/ClientRefreshTokenConfiguration'
require_proof_of_possession:
default: false
description: >-
Rend obligatoire l’utilisation de la preuve de possession pour cette
application
type: boolean
require_pushed_authorization_requests:
default: false
description: >-
Rend obligatoire l’utilisation des requêtes d’autorisation poussée
pour cette application
type: boolean
resource_server_identifier:
description: >-
L’identifiant du serveur de ressources auquel cette application est
liée.
type: string
session_transfer:
$ref: '#/components/schemas/ClientSessionTransferConfiguration'
signed_request_object:
$ref: '#/components/schemas/ClientSignedRequestObjectWithCredentialId'
signing_keys:
$ref: '#/components/schemas/ClientSigningKeys'
skip_non_verifiable_callback_uri_confirmation_prompt:
description: >-
Contrôle si une invite de confirmation s’affiche pendant les flux de
connexion lorsque l’URI de redirection utilise des URI de callback
non vérifiables (par exemple, un schéma d’URI personnalisé comme
`myapp://` ou `localhost`).
Si la valeur est true, aucune invite de confirmation ne s’affichera.
Nous recommandons de définir cette valeur à false pour mieux vous
protéger contre les applications malveillantes.
Consultez
https://auth0.com/docs/secure/security-guidance/measures-against-app-impersonation
pour en savoir plus.
type: boolean
sso:
default: false
description: >-
S’applique uniquement aux applications SSO et détermine si Auth0
prendra en charge l’authentification unique (true) ou si ce sera le
fournisseur d’identité (false).
type: boolean
sso_disabled:
default: false
description: >-
Indique si l’authentification unique est désactivée (true) ou
activée (true). La valeur par défaut est true.
type: boolean
tenant:
default: ''
description: Nom du locataire auquel appartient cette application.
type: string
third_party_security_mode:
$ref: '#/components/schemas/ClientThirdPartySecurityModeEnum'
x-release-lifecycle: GA
token_endpoint_auth_method:
$ref: '#/components/schemas/ClientTokenEndpointAuthMethodEnum'
token_exchange:
$ref: '#/components/schemas/ClientTokenExchangeConfiguration'
x-release-lifecycle: GA
token_quota:
$ref: '#/components/schemas/TokenQuota'
x-release-lifecycle: EA
web_origins:
description: >-
Liste d’origines autorisées, séparées par des virgules, à utiliser
avec l’authentification
inter-origine, le flux
d’appareil et le mode
de réponse web message.
items:
type: string
type: array
type: object
ClientAddons:
additionalProperties: false
description: >-
Modules complémentaires activés pour ce client et leurs configurations
associées.
properties:
aws:
$ref: '#/components/schemas/ClientAddonAWS'
azure_blob:
$ref: '#/components/schemas/ClientAddonAzureBlob'
azure_sb:
$ref: '#/components/schemas/ClientAddonAzureSB'
box:
$ref: '#/components/schemas/ClientAddonBox'
cloudbees:
$ref: '#/components/schemas/ClientAddonCloudBees'
concur:
$ref: '#/components/schemas/ClientAddonConcur'
dropbox:
$ref: '#/components/schemas/ClientAddonDropbox'
echosign:
$ref: '#/components/schemas/ClientAddonEchoSign'
egnyte:
$ref: '#/components/schemas/ClientAddonEgnyte'
firebase:
$ref: '#/components/schemas/ClientAddonFirebase'
layer:
$ref: '#/components/schemas/ClientAddonLayer'
mscrm:
$ref: '#/components/schemas/ClientAddonMSCRM'
newrelic:
$ref: '#/components/schemas/ClientAddonNewRelic'
oag:
$ref: '#/components/schemas/ClientAddonOAG'
office365:
$ref: '#/components/schemas/ClientAddonOffice365'
rms:
$ref: '#/components/schemas/ClientAddonRMS'
salesforce:
$ref: '#/components/schemas/ClientAddonSalesforce'
salesforce_api:
$ref: '#/components/schemas/ClientAddonSalesforceAPI'
salesforce_sandbox_api:
$ref: '#/components/schemas/ClientAddonSalesforceSandboxAPI'
samlp:
$ref: '#/components/schemas/ClientAddonSAML'
sap_api:
$ref: '#/components/schemas/ClientAddonSAPAPI'
sentry:
$ref: '#/components/schemas/ClientAddonSentry'
sharepoint:
$ref: '#/components/schemas/ClientAddonSharePoint'
slack:
$ref: '#/components/schemas/ClientAddonSlack'
springcm:
$ref: '#/components/schemas/ClientAddonSpringCM'
sso_integration:
$ref: '#/components/schemas/ClientAddonSSOIntegration'
wams:
$ref: '#/components/schemas/ClientAddonWAMS'
wsfed:
$ref: '#/components/schemas/ClientAddonWSFed'
zendesk:
$ref: '#/components/schemas/ClientAddonZendesk'
zoom:
$ref: '#/components/schemas/ClientAddonZoom'
type: object
ClientAppTypeEnum:
description: Le type d’application que représente ce client
enum:
- native
- spa
- regular_web
- non_interactive
- resource_server
- express_configuration
- rms
- box
- cloudbees
- concur
- dropbox
- mscrm
- echosign
- egnyte
- newrelic
- office365
- salesforce
- sentry
- sharepoint
- slack
- springcm
- zendesk
- zoom
- sso_integration
- oag
type: string
ClientAsyncApprovalNotificationsChannelsAPIPatchConfiguration:
description: >-
Tableau des canaux de notification pour communiquer avec l’utilisateur
lorsque son approbation est requise. Les valeurs valides sont
`guardian-push`, `email`.
items:
$ref: '#/components/schemas/AsyncApprovalNotificationsChannelsEnum'
minItems: 1
type:
- array
- 'null'
ClientAuthenticationMethod:
additionalProperties: false
description: Définit les méthodes d’authentification du client.
maxProperties: 1
minProperties: 1
properties:
private_key_jwt:
$ref: '#/components/schemas/ClientAuthenticationMethodPrivateKeyJWT'
self_signed_tls_client_auth:
$ref: >-
#/components/schemas/ClientAuthenticationMethodSelfSignedTLSClientAuth
tls_client_auth:
$ref: '#/components/schemas/ClientAuthenticationMethodTLSClientAuth'
type:
- object
- 'null'
ClientMetadata:
additionalProperties: true
description: "Métadonnées associées à l’application, sous la forme d’un objet contenant des valeurs de type chaîne de caractères (max. 255 caractères). Maximum de 10 propriétés de métadonnées autorisées. Les noms de champ (max. 255 caractères) sont alphanumériques et peuvent inclure uniquement les caractères spéciaux suivants\_: :,-+=_*?\"/\\()<>@\t[Tab] [espace]"
maxProperties: 10
type: object
ClientComplianceLevelEnum:
description: >-
Définit le niveau de conformité de cette application, ce qui peut en
restreindre les capacités.
enum:
- none
- fapi1_adv_pkj_par
- fapi1_adv_mtls_par
- fapi2_sp_pkj_mtls
- fapi2_sp_mtls_mtls
- null
type:
- string
- 'null'
ClientDefaultOrganization:
additionalProperties: false
description: Définit l’ID d’Organisation par défaut et les flux.
properties:
flows:
description: L’utilisation de l’Organisation par défaut
items:
$ref: '#/components/schemas/ClientDefaultOrganizationFlowsEnum'
type: array
organization_id:
description: L’ID d’Organisation par défaut à utiliser
format: organization-id
type: string
required:
- organization_id
- flows
type:
- object
- 'null'
ClientEncryptionKey:
additionalProperties: true
description: Chiffrement utilisé pour les réponses WsFed avec cette application.
properties:
cert:
description: >-
Certificat de chiffrement pour la clé publique au format X.509
(.CER).
type: string
pub:
description: Clé RSA publique de chiffrement.
type: string
subject:
description: >-
Nom du certificat de chiffrement pour ce certificat, au format
`/CN={domain}`.
type: string
type:
- object
- 'null'
ExpressConfigurationOrNull:
additionalProperties: false
description: >-
Configuration propre à l’application pour la fonctionnalité
Configuration Express OIN.
properties:
admin_login_domain:
description: >-
Il s’agit du domaine que les administrateurs doivent utiliser pour
se connecter dans le cadre de l’authentification pour la
configuration express. Il peut s’agir du domaine canonique ou d’un
domaine personnalisé enregistré.
minLength: 1
type: string
connection_profile_id:
description: ID du profil de connexion à utiliser pour cette application.
format: connection-profile-id
type: string
enable_client:
description: >-
Si la valeur est true, toutes les connexions créées via la
configuration express seront activées pour cette application.
type: boolean
enable_organization:
description: >-
Si la valeur est true, l’organisation associée sera activée pour
toutes les connexions créées via la configuration express.
type: boolean
initiate_login_uri_template:
description: "URI que les utilisateurs doivent ajouter à leurs favoris pour se connecter à cette application. La substitution de variables est autorisée pour les propriétés suivantes\_: organization_name, organization_id et connection_name."
format: ec-initiate-login-uri-template-url
type: string
linked_clients:
description: >-
Liste des ID client liés à cette configuration express (par ex. des
applications Web ou mobiles).
items:
$ref: '#/components/schemas/LinkedClientConfiguration'
type: array
oin_submission_id:
description: Identifiant de l’application publiée dans l’OKTA OIN.
maxLength: 200
minLength: 1
type: string
okta_oin_client_id:
description: >-
Il s’agit de l’identifiant unique du client Configuration Express
OIN d’Okta, qu’Okta utilisera pour cette application.
format: client-id
type: string
user_attribute_profile_id:
description: >-
ID du profil d’attributs utilisateur à utiliser pour cette
application.
format: user-attribute-profile-id
type: string
required:
- initiate_login_uri_template
- user_attribute_profile_id
- connection_profile_id
- enable_client
- enable_organization
- okta_oin_client_id
- admin_login_domain
type:
- object
- 'null'
FedCMLoginPatch:
additionalProperties: false
description: Configurer les paramètres de Login FedCM pour New Universal Login
minProperties: 1
properties:
google:
$ref: '#/components/schemas/FedCMLoginGooglePatch'
type:
- object
- 'null'
x-release-lifecycle: EA
ClientJwtConfiguration:
additionalProperties: true
description: Configuration liée aux JWT pour l’application.
properties:
alg:
$ref: '#/components/schemas/SigningAlgorithmEnum'
lifetime_in_seconds:
default: 36000
description: >-
Nombre de secondes pendant lesquelles le JWT sera valide (affecte la
revendication `exp`).
type: integer
scopes:
$ref: '#/components/schemas/ClientJwtConfigurationScopes'
secret_encoded:
default: true
description: >-
Indique si le Secret client est encodé en base64 (true) ou non
encodé (false).
type: boolean
type: object
ClientMobile:
additionalProperties: true
description: Configuration supplémentaire pour les applications mobiles natives.
properties:
android:
$ref: '#/components/schemas/ClientMobileAndroid'
ios:
$ref: '#/components/schemas/ClientMobileiOS'
type: object
ClientMyOrganizationPatchConfiguration:
additionalProperties: false
description: Configuration liée à My Organization Configuration pour l’application.
properties:
allowed_strategies:
description: >-
Les stratégies de connexion autorisées pour My Organization
Configuration.
items:
$ref: >-
#/components/schemas/ClientMyOrganizationConfigurationAllowedStrategiesEnum
type: array
connection_deletion_behavior:
$ref: '#/components/schemas/ClientMyOrganizationDeletionBehaviorEnum'
connection_profile_id:
description: >-
L’ID du profil de connexion par rapport auquel cette application
doit être validée.
format: connection-profile-id
type: string
invitation_landing_client_id:
description: >-
L’ID client que cette application utilise pour créer des invitations
au moyen de l’API My Organization.
format: client-id
type: string
user_attribute_profile_id:
description: >-
L’ID du profil d’attributs utilisateur par rapport auquel cette
application doit être validée.
format: user-attribute-profile-id
type: string
required:
- allowed_strategies
- connection_deletion_behavior
type:
- object
- 'null'
x-release-lifecycle: EA
NativeSocialLoginPatch:
additionalProperties: false
description: Configurer les paramètres de connexion sociale native
minProperties: 1
properties:
apple:
$ref: '#/components/schemas/NativeSocialLoginApplePatch'
facebook:
$ref: '#/components/schemas/NativeSocialLoginFacebookPatch'
google:
$ref: '#/components/schemas/NativeSocialLoginGooglePatch'
type:
- object
- 'null'
ClientOIDCBackchannelLogoutSettings:
additionalProperties: true
description: Configuration de la déconnexion OIDC par canal arrière
properties:
backchannel_logout_initiators:
$ref: '#/components/schemas/ClientOIDCBackchannelLogoutInitiators'
backchannel_logout_session_metadata:
$ref: '#/components/schemas/ClientOIDCBackchannelLogoutSessionMetadata'
backchannel_logout_urls:
description: >-
Liste d’URL séparées par des virgules qui sont valides comme URL de
rappel depuis Auth0 pour la déconnexion OIDC par canal arrière. Une
seule URL est actuellement autorisée.
items:
format: absolute-https-uri-with-placeholders-or-empty
type: string
type: array
type: object
ClientOrganizationDiscoveryEnum:
description: >-
Méthode de découverte des organisations pendant `pre_login_prompt`.
`email` permet aux utilisateurs de trouver leur organisation en entrant
leur adresse de courriel et en faisant correspondre le domaine, tandis
que `organization_name` oblige les utilisateurs à entrer directement le
nom de l’organisation. Ces méthodes peuvent être combinées.
enum:
- email
- organization_name
type: string
ClientOrganizationRequireBehaviorPatchEnum:
default: no_prompt
description: >-
Définit comment procéder pendant une transaction d’authentification
lorsque `client.organization_usage: 'require'`. Les valeurs possibles
sont `no_prompt` (par défaut), `pre_login_prompt` ou
`post_login_prompt`. `post_login_prompt` exige `oidc_conformant: true`.
enum:
- no_prompt
- pre_login_prompt
- post_login_prompt
- null
type:
- string
- 'null'
ClientOrganizationUsagePatchEnum:
default: deny
description: >-
Définit comment procéder pendant une transaction d’authentification en
ce qui concerne une organisation. Les valeurs possibles sont `deny` (par
défaut), `allow` ou `require`.
enum:
- deny
- allow
- require
- null
type:
- string
- 'null'
ClientRedirectionPolicyEnum:
description: >-
Contrôle si Auth0 redirige les utilisateurs vers l’URL de rappel de
l’application en cas d’erreurs d’authentification ou dans les flux de
vérification du courriel. `open_redirect_protection` affiche plutôt une
page d’erreur que d’effectuer une redirection et masque le domaine de
rappel dans les modèles de courriel. `allow_always` active le
comportement de redirection standard. La valeur par défaut est
`open_redirect_protection` pour les applications tierces. S’applique
uniquement lorsque `is_first_party` est `false` et que
`third_party_security_mode` est `strict`. Pour en savoir plus, consultez
Protection
contre les redirections.
enum:
- allow_always
- open_redirect_protection
type: string
x-release-lifecycle: GA
ClientRefreshTokenConfiguration:
additionalProperties: false
description: Configuration des jetons d’actualisation
properties:
expiration_type:
$ref: '#/components/schemas/RefreshTokenExpirationTypeEnum'
idle_token_lifetime:
description: >-
Période (en secondes) pendant laquelle les jetons d’actualisation
demeurent valides sans être utilisés
minimum: 1
type: integer
infinite_idle_token_lifetime:
default: false
description: >-
Empêche les jetons d’expirer en l’absence d’utilisation lorsque
`true` (a préséance sur les valeurs de `idle_token_lifetime`)
type: boolean
infinite_token_lifetime:
description: >-
Empêche les jetons d’avoir une durée de vie définie lorsque `true`
(a préséance sur les valeurs de `token_lifetime`)
type: boolean
leeway:
default: 0
description: >-
Période, en secondes, pendant laquelle le jeton d’actualisation
précédent peut être échangé sans déclencher la détection de
compromission
minimum: 0
type: integer
policies:
description: >-
Ensemble de stratégies régissant l’échange de jetons d’actualisation
multiresource (MRRT), qui définissent comment les jetons
d’actualisation peuvent être utilisés avec différents serveurs de
ressources
items:
$ref: '#/components/schemas/ClientRefreshTokenPolicy'
minItems: 1
type:
- array
- 'null'
rotation_type:
$ref: '#/components/schemas/RefreshTokenRotationTypeEnum'
token_lifetime:
description: >-
Période (en secondes) pendant laquelle les jetons d’actualisation
demeurent valides
maximum: 157788000
minimum: 1
type: integer
required:
- rotation_type
- expiration_type
type:
- object
- 'null'
ClientSessionTransferConfiguration:
additionalProperties: false
description: Configuration du SSO natif vers le Web
properties:
allow_refresh_token:
default: false
description: >-
Indique si des jetons d’actualisation peuvent être émis lors de
l’authentification avec un jeton de transfert de session.
Habituellement configuré dans l’application Web. La valeur par
défaut est `false`.
type: boolean
allowed_authentication_methods:
description: >-
Indique si une application peut créer une session à partir d’un
jeton de transfert de session reçu par les méthodes indiquées. Peut
inclure `cookie` et/ou `query`. Habituellement configuré dans
l’application Web. La valeur par défaut est un tableau vide `[]`.
items:
$ref: >-
#/components/schemas/ClientSessionTransferAllowedAuthenticationMethodsEnum
type:
- array
- 'null'
can_create_session_transfer_token:
default: false
description: >-
Indique si une application peut émettre un jeton de transfert de
session au moyen de l’échange de jetons. Si la valeur est `false`,
l’application ne pourra pas émettre de jeton de transfert de
session. Habituellement configuré dans l’application native. La
valeur par défaut est `false`.
type: boolean
delegation:
$ref: '#/components/schemas/ClientSessionTransferDelegationConfiguration'
x-release-lifecycle: EA
enforce_cascade_revocation:
default: true
description: >-
Indique si la révocation du Jeton d’actualisation parent qui a
initié un flux natif vers le Web et qui a servi à émettre un jeton
de transfert de session doit déclencher une révocation en cascade
touchant ses entités enfants dépendantes. Habituellement configuré
dans l’application native. La valeur par défaut est `true` et
s’applique uniquement dans le contexte du SSO natif vers le Web.
type: boolean
enforce_device_binding:
$ref: '#/components/schemas/ClientSessionTransferDeviceBindingEnum'
enforce_online_refresh_tokens:
default: true
description: >-
Indique si les jetons d’actualisation créés pendant une session SSO
natif vers le Web sont liés à la durée de vie de cette session. Cela
détermine si ces jetons d’actualisation doivent être automatiquement
révoqués lorsque leurs sessions correspondantes le sont.
Habituellement configuré dans l’application Web. La valeur par
défaut est `true` et s’applique uniquement dans le contexte du SSO
natif vers le Web.
type: boolean
type:
- object
- 'null'
ClientSignedRequestObjectWithCredentialId:
additionalProperties: false
description: Paramètres des requêtes d’autorisation sécurisées par JWT (JAR).
properties:
credentials:
items:
$ref: '#/components/schemas/CredentialId'
minItems: 0
type: array
required:
default: false
description: Indique si les requêtes JAR sont obligatoires
type: boolean
type: object
ClientThirdPartySecurityModeEnum:
description: "Mode de sécurité pour les applications tierces. `strict` applique des contrôles de sécurité renforcés\_: alignement sur OAuth 2.1, autorisation explicite des API et ensemble sélectionné de fonctionnalités prises en charge. `permissive` préserve le comportement existant et n’est disponible que pour les locataires ayant déjà utilisé des applications tierces. Cette valeur est définie à la création et ne peut pas être modifiée."
enum:
- strict
- permissive
type: string
x-release-lifecycle: GA
ClientTokenEndpointAuthMethodOrNullEnum:
default: none
description: >-
Définit la méthode d’authentification demandée pour le point de
terminaison de jeton. Les valeurs possibles sont `none` (application
publique sans secret client), `client_secret_post` (l’application
utilise des paramètres HTTP POST) ou `client_secret_basic`
(l’application utilise HTTP Basic).
enum:
- none
- client_secret_post
- client_secret_basic
- null
type:
- string
- 'null'
ClientTokenExchangeConfigurationOrNull:
additionalProperties: false
description: Configuration de l’échange de jetons.
properties:
allow_any_profile_of_type:
description: >-
Répertorie les types d’échange de jetons activés pour cette
application.
items:
$ref: '#/components/schemas/ClientTokenExchangeTypeEnum'
minItems: 0
type: array
type:
- object
- 'null'
x-release-lifecycle: GA
UpdateTokenQuota:
additionalProperties: false
properties:
client_credentials:
$ref: '#/components/schemas/TokenQuotaClientCredentials'
required:
- client_credentials
type:
- object
- 'null'
x-release-lifecycle: EA
ClientAsyncApprovalNotificationsChannelsAPIPostConfiguration:
description: >-
Tableau des canaux de notification pour communiquer avec l’utilisateur
lorsque son approbation est requise. Les valeurs valides sont
`guardian-push`, `email`.
items:
$ref: '#/components/schemas/AsyncApprovalNotificationsChannelsEnum'
minItems: 1
type: array
ExpressConfiguration:
additionalProperties: false
description: >-
Configuration propre à l’application pour la fonctionnalité
Configuration Express OIN.
properties:
admin_login_domain:
description: >-
Il s’agit du domaine que les administrateurs doivent utiliser pour
se connecter dans le cadre de l’authentification pour la
configuration express. Il peut s’agir du domaine canonique ou d’un
domaine personnalisé enregistré.
minLength: 1
type: string
connection_profile_id:
description: ID du profil de connexion à utiliser pour cette application.
format: connection-profile-id
type: string
enable_client:
description: >-
Si la valeur est true, toutes les connexions créées via la
configuration express seront activées pour cette application.
type: boolean
enable_organization:
description: >-
Si la valeur est true, l’organisation associée sera activée pour
toutes les connexions créées via la configuration express.
type: boolean
initiate_login_uri_template:
description: "URI que les utilisateurs doivent ajouter à leurs favoris pour se connecter à cette application. La substitution de variables est autorisée pour les propriétés suivantes\_: organization_name, organization_id et connection_name."
format: ec-initiate-login-uri-template-url
type: string
linked_clients:
description: >-
Liste des ID client liés à cette configuration express (par ex. des
applications Web ou mobiles).
items:
$ref: '#/components/schemas/LinkedClientConfiguration'
type: array
oin_submission_id:
description: Identifiant de l’application publiée dans l’OKTA OIN.
maxLength: 200
minLength: 1
type: string
okta_oin_client_id:
description: >-
Il s’agit de l’identifiant unique du client Configuration Express
OIN d’Okta, qu’Okta utilisera pour cette application.
format: client-id
type: string
user_attribute_profile_id:
description: >-
ID du profil d’attributs utilisateur à utiliser pour cette
application.
format: user-attribute-profile-id
type: string
required:
- initiate_login_uri_template
- user_attribute_profile_id
- connection_profile_id
- enable_client
- enable_organization
- okta_oin_client_id
- admin_login_domain
type: object
ClientExternalMetadataCreatedByEnum:
description: >-
Indique qui a créé l’application avec métadonnées externes. La valeur
admin indique que l’application a été enregistrée au moyen
de la Management API. La valeur client indique que
l’application a été enregistrée dynamiquement. Ce champ n’est présent
que lorsque external_metadata_type est défini.
enum:
- admin
- client
type: string
ClientExternalMetadataTypeEnum:
description: >-
Indique le type de métadonnées externes utilisé pour enregistrer
l’application. Ce champ est omis pour les applications ordinaires. La
valeur cimd identifie les applications enregistrées au
moyen d’un document de métadonnées d’ID client. La valeur
dcr identifie les applications enregistrées au moyen de
l’Enregistrement dynamique des applications.
enum:
- cimd
- dcr
type: string
FedCMLogin:
additionalProperties: false
description: Configurer les paramètres de connexion FedCM pour New Universal Login
minProperties: 1
properties:
google:
$ref: '#/components/schemas/FedCMLoginGoogle'
type: object
x-release-lifecycle: EA
ClientMyOrganizationResponseConfiguration:
additionalProperties: false
description: Configuration liée à My Organization Configuration pour l’application.
properties:
allowed_strategies:
description: >-
Les stratégies de connexion autorisées pour la configuration My
Organization.
items:
$ref: >-
#/components/schemas/ClientMyOrganizationConfigurationAllowedStrategiesEnum
type: array
connection_deletion_behavior:
$ref: '#/components/schemas/ClientMyOrganizationDeletionBehaviorEnum'
connection_profile_id:
description: >-
L’ID du profil de connexion que cette application doit utiliser pour
la validation.
format: connection-profile-id
type: string
invitation_landing_client_id:
description: >-
L’ID client que cette application utilise pour créer des invitations
au moyen de l’API My Organization.
format: client-id
type: string
user_attribute_profile_id:
description: >-
L’ID du profil d’attributs utilisateur que cette application doit
utiliser pour la validation.
format: user-attribute-profile-id
type: string
required:
- allowed_strategies
- connection_deletion_behavior
type: object
x-release-lifecycle: EA
NativeSocialLogin:
additionalProperties: false
description: Configurer les paramètres de connexion sociale native
minProperties: 1
properties:
apple:
$ref: '#/components/schemas/NativeSocialLoginApple'
facebook:
$ref: '#/components/schemas/NativeSocialLoginFacebook'
google:
$ref: '#/components/schemas/NativeSocialLoginGoogle'
type: object
ClientOrganizationRequireBehaviorEnum:
default: no_prompt
description: >-
Définit comment procéder pendant une transaction d’authentification
lorsque `client.organization_usage: 'require'`. Les valeurs possibles
sont `no_prompt` (par défaut), `pre_login_prompt` ou
`post_login_prompt`. `post_login_prompt` exige `oidc_conformant: true`.
enum:
- no_prompt
- pre_login_prompt
- post_login_prompt
type: string
ClientOrganizationUsageEnum:
default: deny
description: >-
Définit comment procéder pendant une transaction d’authentification en
ce qui concerne une organisation. Les valeurs possibles sont `deny` (par
défaut), `allow` ou `require`.
enum:
- deny
- allow
- require
type: string
ClientSigningKeys:
description: Certificats de signature associés à cette application.
items:
$ref: '#/components/schemas/ClientSigningKey'
type:
- array
- 'null'
ClientTokenEndpointAuthMethodEnum:
default: none
description: >-
Définit la méthode d’authentification demandée pour le point de
terminaison de jeton. Les valeurs possibles sont `none` (application
publique sans secret client), `client_secret_post` (l’application
utilise des paramètres HTTP POST) ou `client_secret_basic`
(l’application utilise HTTP Basic).
enum:
- none
- client_secret_post
- client_secret_basic
type: string
ClientTokenExchangeConfiguration:
additionalProperties: false
description: Configuration de l’échange de jetons.
properties:
allow_any_profile_of_type:
description: >-
Répertorie les types d’échange de jetons activés pour cette
application.
items:
$ref: '#/components/schemas/ClientTokenExchangeTypeEnum'
minItems: 0
type: array
type: object
x-release-lifecycle: GA
TokenQuota:
additionalProperties: false
properties:
client_credentials:
$ref: '#/components/schemas/TokenQuotaClientCredentials'
required:
- client_credentials
type: object
x-release-lifecycle: EA
ClientAddonAWS:
additionalProperties: true
description: Configuration de l’addon AWS.
properties:
lifetime_in_seconds:
description: Durée de vie du jeton AWS en secondes
maximum: 43200
minimum: 900
type: integer
principal:
description: >-
ARN principal AWS, par ex.
`arn:aws:iam::010616021751:saml-provider/idpname`
type: string
role:
description: ARN du rôle AWS, par ex. `arn:aws:iam::010616021751:role/foo`
type: string
type: object
ClientAddonAzureBlob:
additionalProperties: true
description: Configuration de l’addon Azure Blob Storage.
properties:
accountName:
description: >-
Le nom de votre compte de stockage Azure. Il s’agit généralement du
premier segment de votre URL de stockage Azure. Par exemple, pour
`https://acme-org.blob.core.windows.net`, le nom du compte serait
`acme-org`.
pattern: ^([a-z0-9]){3,24}$
type: string
blobName:
description: >-
Entité pour laquelle demander un jeton. Par exemple, `my-blob`. Si
ce champ est vide, le SAS calculé s’appliquera à l’ensemble du
conteneur de stockage.
pattern: ^(.){1,1024}$
type: string
blob_delete:
description: Indique si le jeton émis a la permission de supprimer l’objet blob.
type: boolean
blob_read:
description: >-
Indique si le jeton émis a la permission de lire le contenu, les
propriétés, les métadonnées et la liste de blocs. Utilisez l’objet
blob comme source d’une opération de copie.
type: boolean
blob_write:
description: >-
Indique si le jeton émis a la permission de créer ou d’écrire du
contenu, des propriétés, des métadonnées ou la liste de blocs. Créez
un instantané de l’objet blob ou accordez-lui un bail.
Redimensionnez l’objet blob (blob de pages uniquement). Utilisez
l’objet blob comme destination d’une opération de copie dans le même
compte.
type: boolean
containerName:
description: >-
Conteneur pour lequel demander un jeton. Par exemple,
`my-container`.
pattern: ^([a-z0-9]){1}([a-z0-9-]){2,62}$
type: string
container_delete:
description: >-
Indique si le jeton émis a la permission de supprimer tout objet
blob dans le conteneur.
type: boolean
container_list:
description: >-
Indique si le jeton émis a la permission de répertorier les objets
blob dans le conteneur.
type: boolean
container_read:
description: >-
Indique si le jeton émis a la permission de lire le contenu, les
propriétés, les métadonnées ou la liste de blocs de tout objet blob
dans le conteneur. Utilisez n’importe quel objet blob du conteneur
comme source d’une opération de copie.
type: boolean
container_write:
description: >-
Indique si, pour tout objet blob dans le conteneur, le jeton émis a
la permission de créer ou d’écrire du contenu, des propriétés, des
métadonnées ou la liste de blocs. Créez un instantané de l’objet
blob ou accordez-lui un bail. Redimensionnez l’objet blob (blob de
pages uniquement). Utilisez l’objet blob comme destination d’une
opération de copie dans le même compte.
type: boolean
expiration:
description: >-
Durée d’expiration en minutes du jeton généré (5 minutes par
défaut).
minimum: 0
type: integer
signedIdentifier:
description: >-
Identifiant de la stratégie d’accès partagé définie dans la
ressource de votre compte de stockage.
type: string
storageAccessKey:
description: Clé d’accès associée à ce compte de stockage.
pattern: ^([A-Za-z0-9+/]){86}==$
type: string
type: object
ClientAddonAzureSB:
additionalProperties: true
description: Configuration du module complémentaire Azure Storage Bus.
properties:
entityPath:
description: >-
Entité pour laquelle vous souhaitez demander un jeton. Par exemple,
`my-queue`.
type: string
expiration:
description: >-
Durée d’expiration facultative en minutes du jeton généré. La valeur
par défaut est de 5 minutes.
type: integer
namespace:
description: >-
Votre espace de noms Azure Service Bus. Il s’agit généralement du
premier segment de votre URL Service Bus (par exemple, pour
`https://acme-org.servicebus.windows.net`, ce serait `acme-org`).
type: string
sasKey:
description: Clé primaire associée à votre stratégie d’accès partagé.
type: string
sasKeyName:
description: >-
Nom de votre stratégie d’accès partagé définie dans votre entité
Service Bus.
type: string
type: object
ClientAddonBox:
additionalProperties: true
description: >-
Indicateur Box SSO (aucun paramètre de configuration requis pour Box
SSO).
type: object
ClientAddonCloudBees:
additionalProperties: true
description: >-
Indicateur CloudBees SSO (aucun paramètre de configuration requis pour
CloudBees SSO).
type: object
ClientAddonConcur:
additionalProperties: true
description: >-
Indicateur Concur SSO (aucun paramètre de configuration requis pour
Concur SSO).
type: object
ClientAddonDropbox:
additionalProperties: true
description: >-
Indicateur Dropbox SSO (aucun paramètre de configuration requis pour
Dropbox SSO).
type: object
ClientAddonEchoSign:
additionalProperties: true
description: Configuration d’Adobe EchoSign SSO.
properties:
domain:
description: >-
Votre domaine personnalisé figurant dans votre URL EchoSign. Par
exemple, pour `https://acme-org.echosign.com`, ce serait `acme-org`.
type: string
type: object
ClientAddonEgnyte:
additionalProperties: true
description: Configuration d’Egnyte SSO.
properties:
domain:
description: >-
Votre domaine personnalisé figurant dans votre URL Egnyte. Par
exemple, pour `https://acme-org.egnyte.com`, ce serait `acme-org`.
type: string
type: object
ClientAddonFirebase:
additionalProperties: true
description: Configuration du module complémentaire Google Firebase.
properties:
client_email:
description: >-
ID du compte de service que vous avez créé (affiché comme
`client_email` dans le fichier JSON généré, jetons SDK v3+
seulement).
type: string
lifetime_in_seconds:
description: >-
Expiration facultative, en secondes, du jeton généré. La valeur par
défaut est de 3600 secondes (jetons SDK v3+ uniquement).
type: integer
private_key:
description: Clé privée pour signer le jeton (jetons SDK v3+ seulement).
type: string
private_key_id:
description: >-
ID facultatif de la clé privée pour obtenir l’en-tête kid dans le
jeton émis (jetons SDK v3+ seulement).
type: string
secret:
description: Secret Google Firebase (SDK 2 seulement).
type: string
type: object
ClientAddonLayer:
additionalProperties: true
description: Configuration du module complémentaire Layer.
properties:
expiration:
description: >-
Expiration facultative, en minutes, du jeton généré. La valeur par
défaut est de 5 minutes.
minimum: 0
type: integer
keyId:
description: >-
Identifiant de la clé d’authentification utilisée pour signer le
jeton Layer.
type: string
principal:
description: >-
Nom de la propriété utilisée comme identifiant utilisateur unique
dans Layer. Si elle n’est pas spécifiée, `user_id` est utilisé.
type: string
privateKey:
description: Clé privée utilisée pour signer le jeton Layer.
type: string
providerId:
description: ID du fournisseur de votre compte Layer
type: string
required:
- providerId
- keyId
- privateKey
type: object
ClientAddonMSCRM:
additionalProperties: true
description: Configuration SSO de Microsoft Dynamics CRM.
properties:
url:
description: URL de l’application Microsoft Dynamics CRM.
format: url
type: string
required:
- url
type: object
ClientAddonNewRelic:
additionalProperties: true
description: Configuration SSO de New Relic.
properties:
account:
description: >-
Votre ID de compte New Relic, que vous trouverez dans votre URL New
Relic après le chemin `/accounts/`. Par exemple,
`https://rpm.newrelic.com/accounts/123456/query` correspond à
`123456`.
type: string
type: object
ClientAddonOAG:
additionalProperties: false
description: Configuration SSO d’Okta Access Gateway
properties: {}
type:
- object
- 'null'
ClientAddonOffice365:
additionalProperties: true
description: Configuration SSO de Microsoft Office 365.
properties:
connection:
description: >-
Connexion de base de données Auth0 facultative pour tester un
locataire Office 365 déjà configuré.
type: string
domain:
description: >-
Nom de domaine de votre instance Office 365. Par exemple,
`acme-org.com`.
type: string
type: object
ClientAddonRMS:
additionalProperties: true
description: Configuration SSO d’Active Directory Rights Management Service.
properties:
url:
description: >-
URL de votre serveur Rights Management. Elle peut être interne ou
externe, mais les utilisateurs doivent pouvoir y accéder.
format: url
type: string
required:
- url
type: object
ClientAddonSalesforce:
additionalProperties: true
description: Configuration SSO de Salesforce.
properties:
entity_id:
description: >-
URL logique arbitraire qui identifie la ressource Salesforce. Par
exemple, `https://acme-org.com`.
format: url
type: string
type: object
ClientAddonSalesforceAPI:
additionalProperties: true
description: Configuration du module complémentaire d’API Salesforce.
properties:
clientid:
description: Consumer Key attribuée par Salesforce à la Connected App.
type: string
communityName:
description: Nom de la communauté.
type: string
community_url_section:
description: Section URL de la communauté.
type: string
principal:
description: >-
Nom de la propriété dans l’objet utilisateur qui correspond à un nom
d’utilisateur Salesforce. Par exemple, `email`.
type: string
type: object
ClientAddonSalesforceSandboxAPI:
additionalProperties: true
description: Configuration du module complémentaire Salesforce Sandbox.
properties:
clientid:
description: Clé client attribuée par Salesforce à l’application Connected App.
type: string
communityName:
description: Nom de la communauté.
type: string
community_url_section:
description: Section URL de la communauté.
type: string
principal:
description: >-
Nom de la propriété dans l’objet utilisateur qui correspond à un nom
d’utilisateur Salesforce. Par exemple, `email`.
type: string
type: object
ClientAddonSAML:
additionalProperties: true
description: >-
Indicateur du module complémentaire SAML2 (aucun paramètre de
configuration n’est requis pour le module complémentaire SAML2).
properties:
audience:
type: string
authnContextClassRef:
type: string
createUpnClaim:
type: boolean
destination:
type: string
digestAlgorithm:
type: string
issuer:
type: string
lifetimeInSeconds:
type: integer
mapIdentities:
type: boolean
mapUnknownClaimsAsIs:
type: boolean
mappings:
$ref: '#/components/schemas/ClientAddonSAMLMapping'
nameIdentifierFormat:
type: string
nameIdentifierProbes:
items:
minLength: 1
type: string
type: array
passthroughClaimsWithNoMapping:
type: boolean
recipient:
type: string
signResponse:
type: boolean
signatureAlgorithm:
type: string
type: object
ClientAddonSAPAPI:
additionalProperties: true
description: Configuration du module complémentaire d’API SAP.
properties:
clientid:
description: >-
Si cette option est activée dans la configuration du client OAuth
2.0 (transaction SOAUTH2), l’attribut SAML client_id doit être
défini et être égal au paramètre de formulaire client_id de la
demande de jeton d’accès.
type: string
nameIdentifierFormat:
description: >-
Élément NameID du Subject pouvant servir à exprimer l’identité de
l’utilisateur. La valeur par défaut est
`urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified`.
type: string
scope:
description: scope demandé pour les API SAP.
type: string
servicePassword:
description: >-
Mot de passe du compte de service à utiliser pour authentifier les
appels d’API au point de terminaison de jeton.
type: string
tokenEndpointUrl:
description: >-
URL du point de terminaison de jeton OAuth2 de votre serveur SAP
OData.
format: url
type: string
usernameAttribute:
description: >-
Nom de la propriété dans l’objet utilisateur qui correspond à un nom
d’utilisateur SAP. Par exemple, `email`.
type: string
type: object
ClientAddonSentry:
additionalProperties: true
description: Configuration du SSO Sentry.
properties:
base_url:
description: >-
Préfixe d’URL, uniquement si vous exécutez Sentry Community Edition;
sinon, laissez-le vide.
type: string
org_slug:
description: >-
Slug généré pour votre organisation Sentry. Se trouve dans votre URL
Sentry. Par exemple, `https://sentry.acme.com/acme-org/` correspond
à `acme-org`.
type: string
type: object
ClientAddonSharePoint:
additionalProperties: true
description: Configuration du SSO SharePoint.
properties:
external_url:
$ref: '#/components/schemas/ClientAddonSharePointExternalURL'
url:
description: URL de l’application SharePoint interne.
type: string
type: object
ClientAddonSlack:
additionalProperties: true
description: >-
Nom de l’équipe ou de l’espace de travail Slack, généralement le premier
segment de votre URL Slack. Par exemple, `https://acme-org.slack.com`
correspond à `acme-org`.
properties:
team:
description: Nom de l’équipe Slack.
type: string
required:
- team
type: object
ClientAddonSpringCM:
additionalProperties: true
description: Configuration du SSO SpringCM.
properties:
acsurl:
description: >-
URL ACS de SpringCM, par exemple
`https://na11.springcm.com/atlas/sso/SSOEndpoint.ashx`.
type: string
type: object
ClientAddonSSOIntegration:
additionalProperties: true
properties:
name:
description: Nom de l’intégration SSO
type: string
version:
description: Version installée de l’intégration SSO
type: string
type: object
ClientAddonWAMS:
additionalProperties: true
description: Configuration du module complémentaire Windows Azure Mobile Services.
properties:
masterkey:
description: Votre clé maîtresse pour Windows Azure Mobile Services.
type: string
type: object
ClientAddonWSFed:
additionalProperties: true
description: >-
Indicateur du module complémentaire WS-Fed (WIF). La configuration
réelle est stockée dans les propriétés `callback` et `client_aliases` du
client.
type: object
ClientAddonZendesk:
additionalProperties: true
description: Configuration du SSO Zendesk.
properties:
accountName:
description: >-
Nom du compte Zendesk, généralement le premier segment de votre URL
Zendesk. Par exemple, `https://acme-org.zendesk.com` correspond à
`acme-org`.
type: string
type: object
ClientAddonZoom:
additionalProperties: true
description: Configuration du SSO Zoom.
properties:
account:
description: >-
Nom du compte Zoom, généralement le premier segment de votre URL
Zoom. Par exemple, `https://acme-org.zoom.us` correspond à
`acme-org`.
type: string
type: object
AsyncApprovalNotificationsChannelsEnum:
enum:
- guardian-push
- email
type: string
ClientAuthenticationMethodPrivateKeyJWT:
additionalProperties: false
description: >-
Définit la méthode d’authentification du client `private_key_jwt`. Si
cette propriété est définie, le client est activé pour utiliser la
méthode d’authentification Private Key JWT.
properties:
credentials:
$ref: >-
#/components/schemas/ClientAuthenticationMethodPrivateKeyJWTCredentials
required:
- credentials
type: object
ClientAuthenticationMethodSelfSignedTLSClientAuth:
additionalProperties: false
description: >-
Définit la méthode d’authentification du client
`self_signed_tls_client_auth`. Si la propriété est définie, le client
est configuré pour utiliser la méthode d’authentification mTLS avec un
certificat autosigné.
properties:
credentials:
$ref: >-
#/components/schemas/ClientAuthenticationMethodSelfSignedTLSClientAuthCredentials
required:
- credentials
type: object
ClientAuthenticationMethodTLSClientAuth:
additionalProperties: false
description: >-
Définit la méthode d’authentification de l’application
`tls_client_auth`. Si cette propriété est définie, l’application est
configurée pour utiliser la méthode d’authentification mTLS basée sur
une AC.
properties:
credentials:
$ref: >-
#/components/schemas/ClientAuthenticationMethodTLSClientAuthCredentials
required:
- credentials
type: object
ClientDefaultOrganizationFlowsEnum:
enum:
- client_credentials
type: string
LinkedClientConfiguration:
additionalProperties: false
description: >-
Configuration des applications liées dans la fonctionnalité
Configuration Express de l’OIN.
properties:
client_id:
description: L’id de l’application liée.
format: client-id
type: string
required:
- client_id
type: object
FedCMLoginGooglePatch:
additionalProperties: false
description: Configuration Google FedCM pour cette application
minProperties: 1
properties:
is_enabled:
default: false
description: >-
Lorsque la valeur est true, affiche l’invite Google FedCM dans New
Universal Login pour cette application
type: boolean
type:
- object
- 'null'
SigningAlgorithmEnum:
default: HS256
description: >-
Algorithme utilisé pour signer les JWT. Peut être `HS256` (par défaut)
ou `RS256`. `PS256` est offert via un addon.
enum:
- HS256
- RS256
- RS512
- PS256
type: string
ClientJwtConfigurationScopes:
additionalProperties: true
description: >-
Configuration liée aux revendications du jeton d’identité pour
l’application.
type: object
ClientMobileAndroid:
additionalProperties: true
description: Configuration de l’application Android native.
properties:
app_package_name:
default: ''
description: Package Name de l’application figurant dans AndroidManifest.xml.
type: string
sha256_cert_fingerprints:
description: >-
Empreintes SHA256 du certificat de signature de l’application.
Plusieurs empreintes peuvent être utilisées pour prendre en charge
différentes versions de votre application, comme les versions de
débogage et de production.
items:
minLength: 1
type: string
minItems: 1
type: array
type: object
ClientMobileiOS:
additionalProperties: true
description: Configuration de l’application iOS native.
properties:
app_bundle_identifier:
default: ''
description: >-
Attribué par le développeur à l’application comme identifiant unique
dans la boutique. Il s’agit habituellement d’un domaine inversé
suivi du nom de l’application, par exemple `com.you.MyApp`.
type: string
team_id:
default: ''
description: >-
Identifiant attribué au compte Apple qui signe et téléverse
l’application sur la boutique.
type: string
type: object
ClientMyOrganizationConfigurationAllowedStrategiesEnum:
description: >-
Les valeurs de stratégie de connexion autorisées dans My Organization
Configuration.
enum:
- pingfederate
- adfs
- waad
- google-apps
- okta
- oidc
- samlp
type: string
ClientMyOrganizationDeletionBehaviorEnum:
default: allow
description: Le comportement de suppression pour cette application.
enum:
- allow
- allow_if_empty
type: string
NativeSocialLoginApplePatch:
additionalProperties: false
description: Prise en charge de la connexion sociale native pour la connexion Apple
minProperties: 1
properties:
enabled:
default: false
description: >-
Détermine s’il faut autoriser la connexion native à l’aide d’un code
d’autorisation Apple
type: boolean
type:
- object
- 'null'
NativeSocialLoginFacebookPatch:
additionalProperties: false
description: >-
Prise en charge de la connexion sociale native pour la Connexion
Facebook
minProperties: 1
properties:
enabled:
default: false
description: Détermine s’il faut autoriser la connexion native avec Facebook
type: boolean
type:
- object
- 'null'
NativeSocialLoginGooglePatch:
additionalProperties: false
description: >-
Prise en charge de la connexion sociale native pour la Connexion
google-oauth2
minProperties: 1
properties:
enabled:
default: false
description: >-
Détermine s’il faut autoriser la connexion native à l’aide d’un
jeton d’identité Google
type: boolean
type:
- object
- 'null'
ClientOIDCBackchannelLogoutInitiators:
additionalProperties: true
description: Configuration des initiateurs de déconnexion OIDC par canal arrière
properties:
mode:
$ref: '#/components/schemas/ClientOIDCBackchannelLogoutInitiatorsModeEnum'
selected_initiators:
items:
$ref: '#/components/schemas/ClientOIDCBackchannelLogoutInitiatorsEnum'
type: array
type: object
ClientOIDCBackchannelLogoutSessionMetadata:
additionalProperties: true
description: >-
Contrôle si les métadonnées de session sont incluses dans le jeton de
déconnexion. La valeur par défaut est `null`.
properties:
include:
description: >-
La propriété `include` détermine si les métadonnées de session sont
incluses dans le jeton de déconnexion.
type: boolean
type:
- object
- 'null'
RefreshTokenExpirationTypeEnum:
default: non-expiring
description: "Types d’expiration des jetons d’actualisation, parmi les suivants\_: expiring, non-expiring"
enum:
- expiring
- non-expiring
type: string
ClientRefreshTokenPolicy:
additionalProperties: false
properties:
audience:
description: >-
L’identifiant du serveur de ressources auquel s’applique la
stratégie de jeton d’actualisation multiresource
maxLength: 600
minLength: 1
type: string
scope:
description: >-
Les permissions du serveur de ressources accordées dans le cadre de
la stratégie de jeton d’actualisation multiresource, qui définissent
le contexte dans lequel un jeton d’accès peut être utilisé
items:
description: >-
Une permission de serveur de ressources accordée dans le cadre de
la stratégie de jeton d’actualisation multiresource
maxLength: 280
minLength: 1
type: string
type: array
required:
- audience
- scope
type: object
RefreshTokenRotationTypeEnum:
default: non-rotating
description: "Types de rotation des jetons d’actualisation, parmi les suivants\_: rotating, non-rotating"
enum:
- rotating
- non-rotating
type: string
ClientSessionTransferAllowedAuthenticationMethodsEnum:
enum:
- cookie
- query
type: string
ClientSessionTransferDelegationConfiguration:
additionalProperties: false
description: >-
Configuration de l’accès de délégation (usurpation d’identité) au moyen
de jetons de transfert de session
properties:
allow_delegated_access:
default: false
description: >-
Indique si l’accès de délégation (usurpation d’identité) est
autorisé au moyen de jetons de transfert de session. La valeur par
défaut est `false`.
type: boolean
enforce_device_binding:
$ref: >-
#/components/schemas/ClientSessionTransferDelegationDeviceBindingEnum
type:
- object
- 'null'
x-release-lifecycle: EA
ClientSessionTransferDeviceBindingEnum:
default: ip
description: >-
Indique si la sécurité de la liaison de l’appareil doit être appliquée
pour l’application. Si la valeur est définie sur `ip`, l’application
appliquera la liaison de l’appareil par IP, ce qui signifie que le jeton
de transfert de session doit être consommé à partir de la même IP que
l’émetteur. De même, si la valeur est définie sur `asn`, la liaison de
l’appareil est appliquée par ASN, ce qui signifie que le jeton de
transfert de session doit être consommé à partir du même ASN que
l’émetteur. Si la valeur est définie sur `none`, la liaison de
l’appareil n’est pas appliquée. Cette option est généralement configurée
dans l’application Web. La valeur par défaut est `ip`.
enum:
- ip
- asn
- none
type: string
CredentialId:
additionalProperties: false
properties:
id:
description: ID de l’information d’identification
format: credential-id
type: string
required:
- id
type: object
ClientTokenExchangeTypeEnum:
description: "Type d’échange de jetons. `on_behalf_of_token_exchange`\_: active l’échange de jetons On-Behalf-Of (GA). `custom_authentication`\_: active les profils d’échange de jeton personnalisés (Accès anticipé, nécessite une autorisation)."
enum:
- custom_authentication
- on_behalf_of_token_exchange
minLength: 1
type: string
TokenQuotaClientCredentials:
additionalProperties: false
description: La configuration du quota de jetons
minProperties: 1
properties:
enforce:
description: >-
Si cette option est activée, le quota sera appliqué et les requêtes
qui le dépassent échoueront. Si elle est désactivée, le quota ne
sera pas appliqué, mais des notifications pour les requêtes qui le
dépassent seront disponibles dans les logs.
type: boolean
per_day:
description: Nombre maximal de jetons émis par jour
maximum: 2147483647
minimum: 1
type: integer
per_hour:
description: Nombre maximal de jetons émis par heure
maximum: 2147483647
minimum: 1
type: integer
type: object
FedCMLoginGoogle:
additionalProperties: false
description: Configuration Google FedCM pour cette application
minProperties: 1
properties:
is_enabled:
default: false
description: >-
Lorsque la valeur est true, affiche l’invite FedCM de Google dans
New Universal Login pour cette application
type: boolean
type: object
NativeSocialLoginApple:
additionalProperties: false
description: Prise en charge de la connexion sociale native pour la connexion Apple
minProperties: 1
properties:
enabled:
default: false
description: >-
Détermine s’il faut autoriser la connexion native au moyen d’un code
d’autorisation Apple
type: boolean
type: object
NativeSocialLoginFacebook:
additionalProperties: false
description: >-
Prise en charge de la connexion sociale native pour la connexion
Facebook
minProperties: 1
properties:
enabled:
default: false
description: >-
Détermine s’il faut autoriser la connexion native au moyen de
Facebook
type: boolean
type: object
NativeSocialLoginGoogle:
additionalProperties: false
description: >-
Prise en charge de la connexion sociale native pour la connexion
google-oauth2
minProperties: 1
properties:
enabled:
default: false
description: >-
Détermine s’il faut autoriser la connexion native au moyen d’un
Google ID Token
type: boolean
type: object
ClientSigningKey:
additionalProperties: true
properties:
cert:
default: ''
description: Clé publique du certificat de signature au format X.509 (.CER).
type: string
pkcs7:
default: ''
description: >-
Clé publique et chaîne du certificat de signature au format PKCS#7
(.P7B).
type: string
subject:
default: ''
description: Nom du sujet de ce certificat au format `/CN={domain}`.
type: string
type: object
ClientAddonSAMLMapping:
additionalProperties: true
type: object
ClientAddonSharePointExternalURL:
description: URLs de l’application SharePoint externe si elle est exposée à Internet.
oneOf:
- items:
type: string
type: array
- type: string
ClientAuthenticationMethodPrivateKeyJWTCredentials:
description: >-
Liste des ID d’informations d’identification uniques et déjà créés
activés sur le client pour l’authentification Private Key JWT.
items:
$ref: '#/components/schemas/CredentialId'
minItems: 0
type: array
ClientAuthenticationMethodSelfSignedTLSClientAuthCredentials:
description: >-
Une liste d’ID uniques d’informations d’identification déjà créées et
activées pour l’application en vue de l’authentification mTLS au moyen
d’un certificat autosigné.
items:
$ref: '#/components/schemas/CredentialId'
minItems: 0
type: array
ClientAuthenticationMethodTLSClientAuthCredentials:
description: >-
Une liste d’ID uniques d’informations d’identification déjà créées et
activées pour l’application en vue de l’authentification mTLS basée sur
une AC.
items:
$ref: '#/components/schemas/CredentialId'
minItems: 0
type: array
ClientOIDCBackchannelLogoutInitiatorsModeEnum:
description: >-
La propriété `mode` détermine la méthode de configuration utilisée pour
activer les initiateurs. `custom` active uniquement les initiateurs
listés dans le tableau `selected_initiators`, tandis que `all` active
tous les initiateurs actuels et futurs.
enum:
- custom
- all
type: string
ClientOIDCBackchannelLogoutInitiatorsEnum:
description: >-
La propriété `selected_initiators` contient la liste des initiateurs à
activer pour l’application concernée.
enum:
- rp-logout
- idp-logout
- password-changed
- session-expired
- session-revoked
- account-deleted
- email-identifier-changed
- mfa-phone-unenrolled
- account-deactivated
type: string
ClientSessionTransferDelegationDeviceBindingEnum:
default: ip
description: >-
Indique le mode d’application de la liaison de l’appareil pour l’accès
de délégation (usurpation d’identité). Si la valeur est définie sur
`ip`, la liaison de l’appareil est appliquée par IP. Si la valeur est
définie sur `asn`, la liaison de l’appareil est appliquée par ASN. La
valeur par défaut est `ip`.
enum:
- ip
- asn
type: string
securitySchemes:
bearerAuth:
bearerFormat: jwt
scheme: bearer
type: http
oAuth2ClientCredentials:
flows:
clientCredentials:
scopes:
create:actions: Create Actions
create:authentication_methods: Create Authentication Methods
create:client_credentials: Create Client Credentials
create:client_grants: Create Client Grants
create:clients: Create Clients
create:connection_profiles: Create Connection Profiles
create:connections: Create Connections
create:connections_keys: Create Connections Keys
create:current_user_device_credentials: Create Current User Device Credentials
create:custom_domains: Create Custom Domains
create:custom_signing_keys: Create Custom Signing Keys
create:directory_provisionings: Create Directory Provisionings
create:email_provider: Create Email Provider
create:email_templates: Create Email Templates
create:encryption_keys: Create Encryption Keys
create:event_streams: Create Event Streams
create:experimentation: Create Experimentation
create:flows: Create Flows
create:flows_vault_connections: Create Flows Vault Connections
create:forms: Create Forms
create:group_roles: Create Group Roles
create:guardian_enrollment_tickets: Create Guardian Enrollment Tickets
create:hooks: Create Hooks
create:log_streams: Create Log Streams
create:network_acls: Create Network Acls
create:organization_client_grants: Create Organization Client Grants
create:organization_connections: Create Organization Connections
create:organization_discovery_domains: Create Organization Discovery Domains
create:organization_group_roles: Create Organization Group Roles
create:organization_invitations: Create Organization Invitations
create:organization_member_roles: Create Organization Member Roles
create:organization_members: Create Organization Members
create:organizations: Create Organizations
create:phone_providers: Create Phone Providers
create:phone_templates: Create Phone Templates
create:rate_limit_policies: Create Rate Limit Policies
create:resource_servers: Create Resource Servers
create:role_members: Create Role Members
create:roles: Create Roles
create:rules: Create Rules
create:scim_config: Create Scim Config
create:scim_token: Create Scim Token
create:self_service_profiles: Create Self Service Profiles
create:signing_keys: Create Signing Keys
create:sso_access_tickets: Create Sso Access Tickets
create:token_exchange_profiles: Create Token Exchange Profiles
create:user_attribute_profiles: Create User Attribute Profiles
create:user_tickets: Create User Tickets
create:users: Create Users
create:vdcs_templates: Create Vdcs Templates
delete:actions: Delete Actions
delete:anomaly_blocks: Delete Anomaly Blocks
delete:authentication_methods: Delete Authentication Methods
delete:branding: Delete Branding
delete:client_credentials: Delete Client Credentials
delete:client_grants: Delete Client Grants
delete:clients: Delete Clients
delete:connection_profiles: Delete Connection Profiles
delete:connections: Delete Connections
delete:current_user: Delete Current User
delete:current_user_device_credentials: Delete Current User Device Credentials
delete:custom_domains: Delete Custom Domains
delete:custom_signing_keys: Delete Custom Signing Keys
delete:device_credentials: Delete Device Credentials
delete:directory_provisionings: Delete Directory Provisionings
delete:email_provider: Delete Email Provider
delete:encryption_keys: Delete Encryption Keys
delete:event_streams: Delete Event Streams
delete:experimentation: Delete Experimentation
delete:federated_connections_tokens: Delete Federated Connections Tokens
delete:flows: Delete Flows
delete:flows_executions: Delete Flows Executions
delete:flows_vault_connections: Delete Flows Vault Connections
delete:forms: Delete Forms
delete:grants: Delete Grants
delete:group_roles: Delete Group Roles
delete:groups: Delete Groups
delete:guardian_enrollments: Delete Guardian Enrollments
delete:hooks: Delete Hooks
delete:log_streams: Delete Log Streams
delete:network_acls: Delete Network Acls
delete:organization_client_grants: Delete Organization Client Grants
delete:organization_connections: Delete Organization Connections
delete:organization_discovery_domains: Delete Organization Discovery Domains
delete:organization_group_roles: Delete Organization Group Roles
delete:organization_invitations: Delete Organization Invitations
delete:organization_member_roles: Delete Organization Member Roles
delete:organization_members: Delete Organization Members
delete:organizations: Delete Organizations
delete:phone_providers: Delete Phone Providers
delete:phone_templates: Delete Phone Templates
delete:rate_limit_policies: Delete Rate Limit Policies
delete:refresh_tokens: Delete Refresh Tokens
delete:resource_servers: Delete Resource Servers
delete:role_members: Delete Role Members
delete:roles: Delete Roles
delete:rules: Delete Rules
delete:rules_configs: Delete Rules Configs
delete:scim_config: Delete Scim Config
delete:scim_token: Delete Scim Token
delete:self_service_profiles: Delete Self Service Profiles
delete:sessions: Delete Sessions
delete:sso_access_tickets: Delete Sso Access Tickets
delete:token_exchange_profiles: Delete Token Exchange Profiles
delete:user_attribute_profiles: Delete User Attribute Profiles
delete:users: Delete Users
delete:vdcs_templates: Delete Vdcs Templates
read:actions: Read Actions
read:anomaly_blocks: Read Anomaly Blocks
read:attack_protection: Read Attack Protection
read:authentication_methods: Read Authentication Methods
read:branding: Read Branding
read:client_credentials: Read Client Credentials
read:client_grants: Read Client Grants
read:client_keys: Read Client Keys
read:client_summary: Read Client Summary
read:clients: Read Clients
read:connection_profiles: Read Connection Profiles
read:connections: Read Connections
read:connections_keys: Read Connections Keys
read:current_user: Read Current User
read:custom_domains: Read Custom Domains
read:custom_signing_keys: Read Custom Signing Keys
read:device_credentials: Read Device Credentials
read:directory_provisionings: Read Directory Provisionings
read:email_provider: Read Email Provider
read:email_templates: Read Email Templates
read:encryption_keys: Read Encryption Keys
read:event_deliveries: Read Event Deliveries
read:event_streams: Read Event Streams
read:events: Read Events
read:experimentation: Read Experimentation
read:federated_connections_tokens: Read Federated Connections Tokens
read:flows: Read Flows
read:flows_executions: Read Flows Executions
read:flows_vault_connections: Read Flows Vault Connections
read:forms: Read Forms
read:grants: Read Grants
read:group_members: Read Group Members
read:group_roles: Read Group Roles
read:groups: Read Groups
read:guardian_enrollments: Read Guardian Enrollments
read:guardian_factors: Read Guardian Factors
read:hooks: Read Hooks
read:log_streams: Read Log Streams
read:logs: Read Logs
read:logs_users: Read Logs Users
read:mfa_policies: Read Mfa Policies
read:network_acls: Read Network Acls
read:organization_client_grants: Read Organization Client Grants
read:organization_connections: Read Organization Connections
read:organization_discovery_domains: Read Organization Discovery Domains
read:organization_group_roles: Read Organization Group Roles
read:organization_groups: Read Organization Groups
read:organization_invitations: Read Organization Invitations
read:organization_member_effective_roles: Read Organization Member Effective Roles
read:organization_member_role_source_groups: Read Organization Member Role Source Groups
read:organization_member_roles: Read Organization Member Roles
read:organization_members: Read Organization Members
read:organizations: Read Organizations
read:organizations_summary: Read Organizations Summary
read:phone_providers: Read Phone Providers
read:phone_templates: Read Phone Templates
read:prompts: Read Prompts
read:rate_limit_policies: Read Rate Limit Policies
read:refresh_tokens: Read Refresh Tokens
read:resource_servers: Read Resource Servers
read:role_members: Read Role Members
read:roles: Read Roles
read:rules: Read Rules
read:rules_configs: Read Rules Configs
read:scim_config: Read Scim Config
read:scim_token: Read Scim Token
read:self_service_profile_custom_texts: Read Self Service Profile Custom Texts
read:self_service_profiles: Read Self Service Profiles
read:sessions: Read Sessions
read:signing_keys: Read Signing Keys
read:stats: Read Stats
read:tenant_settings: Read Tenant Settings
read:token_exchange_profiles: Read Token Exchange Profiles
read:user_attribute_profiles: Read User Attribute Profiles
read:user_effective_permissions: Read User Effective Permissions
read:user_effective_roles: Read User Effective Roles
read:user_idp_tokens: Read User Idp Tokens
read:user_permission_source_roles: Read User Permission Source Roles
read:user_role_source_groups: Read User Role Source Groups
read:users: Read Users
read:vdcs_templates: Read Vdcs Templates
update:actions: Update Actions
update:attack_protection: Update Attack Protection
update:authentication_methods: Update Authentication Methods
update:branding: Update Branding
update:client_credentials: Update Client Credentials
update:client_grants: Update Client Grants
update:client_keys: Update Client Keys
update:client_token_vault_privileged_access: Update Client Token Vault Privileged Access
update:clients: Update Clients
update:connection_profiles: Update Connection Profiles
update:connections: Update Connections
update:connections_keys: Update Connections Keys
update:current_user_identities: Update Current User Identities
update:current_user_metadata: Update Current User Metadata
update:custom_domains: Update Custom Domains
update:custom_signing_keys: Update Custom Signing Keys
update:directory_provisionings: Update Directory Provisionings
update:email_provider: Update Email Provider
update:email_templates: Update Email Templates
update:encryption_keys: Update Encryption Keys
update:event_deliveries: Update Event Deliveries
update:event_streams: Update Event Streams
update:experimentation: Update Experimentation
update:flows: Update Flows
update:flows_vault_connections: Update Flows Vault Connections
update:forms: Update Forms
update:guardian_factors: Update Guardian Factors
update:hooks: Update Hooks
update:log_streams: Update Log Streams
update:mfa_policies: Update Mfa Policies
update:network_acls: Update Network Acls
update:organization_connections: Update Organization Connections
update:organization_discovery_domains: Update Organization Discovery Domains
update:organizations: Update Organizations
update:phone_providers: Update Phone Providers
update:phone_templates: Update Phone Templates
update:prompts: Update Prompts
update:rate_limit_policies: Update Rate Limit Policies
update:refresh_tokens: Update Refresh Tokens
update:resource_servers: Update Resource Servers
update:roles: Update Roles
update:rules: Update Rules
update:rules_configs: Update Rules Configs
update:scim_config: Update Scim Config
update:self_service_profile_custom_texts: Update Self Service Profile Custom Texts
update:self_service_profiles: Update Self Service Profiles
update:sessions: Update Sessions
update:signing_keys: Update Signing Keys
update:tenant_settings: Update Tenant Settings
update:token_exchange_profiles: Update Token Exchange Profiles
update:user_attribute_profiles: Update User Attribute Profiles
update:users: Update Users
update:users_app_metadata: Update Users App Metadata
update:vdcs_templates: Update Vdcs Templates
tokenUrl: /oauth/token/
x-form-parameters:
audience: /api/v2/
type: oauth2
````