Utiliser des règles d'administration personnalisées

Les règles d'administrationGoogle Cloud vous offrent un contrôle centralisé et automatisé sur les ressources de votre organisation. En tant qu'administrateur des règles d'administration, vous pouvez définir des ensembles de restrictions appelées contraintes qui s'appliquent aux ressourcesGoogle Cloud et à leurs descendants dans la hiérarchie des ressourcesGoogle Cloud . Chaque ensemble de restrictions constitue une règle d'administration. Vous pouvez appliquer des règles d'administration au niveau d'une organisation, d'un dossier ou d'un projet.

Les règles d'administration offrent des contraintes prédéfinies pour divers servicesGoogle Cloud . Toutefois, si vous souhaitez exercer un contrôle plus précis et personnalisable sur les champs spécifiques qui sont restreints par vos règles d'administration, vous pouvez également créer des règles d'administration personnalisées.

Avantages

Vous pouvez utiliser des règles d'administration personnalisées pour autoriser ou refuser des opérations spécifiques sur les ressources Identity Platform en fonction des exigences de sécurité, de conformité ou de gouvernance de votre application. Par exemple, vous pouvez contrôler les propriétés suivantes :

Vous pouvez désactiver l'option de connexion par mot de passe pour les applications de votre organisation et exiger qu'elles utilisent toujours l'option de connexion par e-mail.
Vous pouvez limiter les applications de votre organisation à l'utilisation d'un fournisseur d'identité (IdP) OIDC avec un émetteur spécifié.
Vous pouvez désactiver les options de fournisseur d'identité OIDC et SAML pour les applications de votre organisation.
Vous pouvez désactiver l'option d'architecture mutualisée pour les applications de votre organisation.

Héritage des règles

Par défaut, les règles d'administration sont héritées par les descendants des ressources sur lesquelles vous les appliquez. Par exemple, si vous appliquez une règle au niveau d'un dossier, Google Cloud l'applique à tous les projets du dossier. Pour mieux comprendre ce comportement et savoir comment le modifier, consultez Règles d'évaluation hiérarchique.

Tarification

Le service de règles d'administration, y compris les règles d'administration prédéfinies et personnalisées, est proposé sans frais.

Limites

Lorsque vous activez Identity Platform pour un projet, Identity Platform crée une configuration par défaut pour ce projet. Le propriétaire du projet ne peut pas modifier les valeurs par défaut de la configuration tant que le projet n'est pas activé. Si vous modifiez l'une des valeurs par défaut avant d'activer le projet, l'activation peut échouer. Pour modifier les valeurs par défaut de la configuration après l'activation, utilisez la méthode updateConfig.

Avant de commencer

Associez votre application à Identity Platform. Pour savoir comment connecter votre application, consultez le guide de démarrage rapide.
Assurez-vous de connaître votre ID d'organisation.

Rôles requis

Pour obtenir les autorisations nécessaires à la gestion des règles d'administration, demandez à votre administrateur de vous accorder les rôles IAM suivants :

Administrateur des règles d'administration (roles/orgpolicy.policyAdmin) sur la ressource d'organisation
Administrateur Identity Toolkit (roles/identitytoolkit.admin) sur la ressource Identity Platform

Pour en savoir plus sur l'attribution de rôles, consultez Gérer l'accès aux projets, aux dossiers et aux organisations.

Ces rôles prédéfinis contiennent les autorisations requises pour gérer les règles d'administration. Pour connaître les autorisations exactes requises, développez la section Autorisations requises :

Autorisations requises

Les autorisations suivantes sont requises pour gérer les règles d'administration :

orgpolicy.constraints.list
orgpolicy.policies.create
orgpolicy.policies.delete
orgpolicy.policies.list
orgpolicy.policies.update
orgpolicy.policy.get
orgpolicy.policy.set

Vous pouvez également obtenir ces autorisations avec des rôles personnalisés ou d'autres rôles prédéfinis.

Créer une contrainte personnalisée

Une contrainte personnalisée est définie dans un fichier YAML, qui spécifie les ressources, méthodes, conditions et actions compatibles avec le service auquel vous appliquez la règle d'administration. Les conditions de vos contraintes personnalisées sont définies à l'aide du langage CEL (Common Expression Language). Pour en savoir plus sur la création de conditions dans des contraintes personnalisées à l'aide du CEL, consultez la section CEL de la page Créer et gérer des contraintes personnalisées.

Pour créer un fichier YAML afin de définir une contrainte personnalisée :

name: organizations/ORGANIZATION_ID/customConstraints/CONSTRAINT_NAME
resourceTypes:
- identitytoolkit.googleapis.com/RESOURCE_NAME
methodTypes: METHOD
condition: CONDITION
actionType: ACTION
displayName: DISPLAY_NAME
description: DESCRIPTION

Remplacez les éléments suivants :

ORGANIZATION_ID : ID de votre organisation (par exemple, 123456789).
CONSTRAINT_NAME : nom souhaité pour votre nouvelle contrainte personnalisée. Une contrainte personnalisée doit commencer par custom. et ne peut inclure que des lettres majuscules, minuscules ou des chiffres (par exemple, custom.allowEmailLinkLogin). La longueur maximale de ce champ est de 70 caractères, sans compter le préfixe, par exemple organizations/123456789/customConstraints/custom.
RESOURCE_NAME : nom (pas l'URI) de la ressource REST de l'API Identity Platform contenant l'objet et le champ que vous souhaitez restreindre. Exemple :identitytoolkit.googleapis.com/Config

CONDITION : condition CEL écrite pour une représentation d'une ressource de service compatible. Ce champ ne doit pas comporter plus de 1 000 caractères. Consultez la section Ressources compatibles pour en savoir plus sur les ressources disponibles pour l'écriture de conditions. Par exemple, "resource.signIn.email.passwordRequired == true".
METHOD : lorsque vous créez une contrainte de configuration ou de création de locataire, spécifiez CREATE. Lorsque vous créez une contrainte UPDATE de configuration ou de locataire, spécifiez les deux comme suit :
```
methodTypes:
- CREATE
- UPDATE
```
ACTION : action à effectuer si la condition est remplie. Peut être défini sur ALLOW ou DENY.
DISPLAY_NAME : nom convivial de la contrainte. Ce champ ne doit pas comporter plus de 200 caractères.
DESCRIPTION : description conviviale de la contrainte, qui sera affichée dans un message d'erreur en cas de non-respect de la règle. Ce champ ne doit pas comporter plus de 2 000 caractères.

Pour en savoir plus sur la création d'une contrainte personnalisée, consultez Définir des contraintes personnalisées.

Configurer une contrainte personnalisée

Console

Pour créer une contrainte personnalisée :

Dans la console Google Cloud , accédez à la page Règles d'administration.
Accéder à la page Règles d'administration
Dans le sélecteur de projets, choisissez le projet pour lequel vous souhaitez définir la règle d'administration.
Cliquez sur Contrainte personnalisée.
Dans la zone Nom à afficher, saisissez un nom lisible par l'humain pour la contrainte. Ce nom est utilisé dans les messages d'erreur et peut servir à l'identification et au débogage. N'utilisez pas d'informations permettant d'identifier personnellement l'utilisateur ni de données sensibles dans les noms à afficher, car ces informations pourraient être divulguées dans les messages d'erreur. Ce champ peut contenir jusqu'à 200 caractères.
Dans la zone ID de contrainte, saisissez le nom souhaité pour votre nouvelle contrainte personnalisée. Une contrainte personnalisée ne peut contenir que des lettres (majuscules et minuscules) ou des chiffres, par exemple custom.disableGkeAutoUpgrade. Ce champ peut contenir jusqu'à 70 caractères, sans compter le préfixe (custom.), par exemple organizations/123456789/customConstraints/custom. N'incluez pas d'informations permettant d'identifier personnellement l'utilisateur ni de données sensibles dans l'ID de votre contrainte, car ces informations pourraient être divulguées dans les messages d'erreur.
Dans la zone Description, saisissez une description lisible par l'humain pour la contrainte. Cette description est utilisée comme message d'erreur en cas de non-respect de la règle. Incluez des informations sur les raisons du non-respect de la règle et sur la façon de résoudre ce cas de non-respect. Veuillez n'inclure aucune information permettant d'identifier l'utilisateur ou donnée sensible dans votre description, car ces informations pourraient être divulguées dans les messages d'erreur. Ce champ peut contenir jusqu'à 2 000 caractères.
Dans la zone Type de ressource, sélectionnez le nom de la ressource REST Google Cloud contenant l'objet et le champ que vous souhaitez restreindre (par exemple, container.googleapis.com/NodePool). La plupart des types de ressources acceptent jusqu'à 20 contraintes personnalisées. Si vous essayez de créer d'autres contraintes personnalisées, l'opération échoue.
Sous Méthode d'application, indiquez si vous souhaitez appliquer la contrainte sur une méthode REST CREATE ou sur les méthodes CREATE et UPDATE. Si vous appliquez la contrainte avec la méthode UPDATE sur une ressource qui ne respecte pas la contrainte, les modifications apportées à cette ressource sont bloquées par la règle d'administration, sauf si elles résolvent le cas de non-respect.

Les services Google Cloud ne prennent pas tous en charge les deux méthodes. Pour connaître les méthodes prises en charge par chaque service, recherchez le service dans la section Services compatibles.

Pour définir une condition, cliquez sur Modifier la condition.

Dans le panneau Ajouter une condition, créez une condition CEL faisant référence à une ressource de service compatible, par exemple resource.management.autoUpgrade == false. Ce champ peut contenir jusqu'à 1 000 caractères. Pour plus d'informations sur l'utilisation du CEL, consultez Common Expression Language. Pour en savoir plus sur les ressources de service que vous pouvez utiliser dans vos contraintes personnalisées, consultez Services compatibles avec les contraintes personnalisées.
Cliquez sur Enregistrer.

Sous Action, indiquez si vous souhaitez autoriser ou refuser la méthode évaluée si la condition ci-dessus est remplie.

L'action "deny" signifie que l'opération de création ou de mise à jour de la ressource est bloquée si la condition renvoie la valeur "true".

L'action "allow" signifie que l'opération de création ou de mise à jour de la ressource n'est autorisée que si la condition renvoie la valeur "true". Tous les autres cas, à l'exception de ceux explicitement listés dans la condition, sont bloqués.

Cliquez sur Créer une contrainte.

Lorsque vous saisissez une valeur dans chaque champ, la configuration YAML équivalant à cette contrainte personnalisée s'affiche sur la droite.

gcloud

Pour créer une contrainte personnalisée, créez un fichier YAML au format suivant :

      name: organizations/ORGANIZATION_ID/customConstraints/CONSTRAINT_NAME
      resourceTypes:
      - RESOURCE_NAME
      methodTypes:
      - CREATE
      condition: "CONDITION"
      actionType: ACTION
      displayName: DISPLAY_NAME
      description: DESCRIPTION

Remplacez les éléments suivants :

ORGANIZATION_ID : ID de votre organisation (par exemple, 123456789).
CONSTRAINT_NAME : nom souhaité pour votre nouvelle contrainte personnalisée. Une contrainte personnalisée ne peut contenir que des lettres (majuscules et minuscules) ou des chiffres, par exemple custom.allowEmailLinkLogin. Ce champ peut contenir jusqu'à 70 caractères.
RESOURCE_NAME : nom complet de la ressource Google Cloudcontenant l'objet et le champ que vous souhaitez restreindre. Par exemple, identitytoolkit.googleapis.com/Config.
CONDITION : condition CEL écrite pour une représentation d'une ressource de service compatible. Ce champ peut contenir jusqu'à 1 000 caractères. Par exemple, "resource.signIn.email.passwordRequired == true".

Pour en savoir plus sur les ressources disponibles pour l'écriture de conditions, consultez Ressources compatibles.

ACTION : action à effectuer si la condition est remplie. Ne peut être que ALLOW.

L'action "allow" signifie que si la condition renvoie "true", l'opération de création ou de mise à jour de la ressource est autorisée. Cela signifie également que tous les autres cas, à l'exception de celui explicitement listé dans la condition, sont bloqués.

DISPLAY_NAME : nom lisible par l'humain de la contrainte. Ce champ peut contenir jusqu'à 200 caractères.
DESCRIPTION : description lisible par l'humain de la contrainte, qui sera affichée dans un message d'erreur en cas de non-respect de la règle. Ce champ peut contenir jusqu'à 2 000 caractères.

Après avoir créé le fichier YAML pour une nouvelle contrainte personnalisée, vous devez le configurer de sorte qu'il soit disponible pour les règles d'administration de votre organisation. Pour configurer une contrainte personnalisée, utilisez la commande gcloud org-policies set-custom-constraint :

        gcloud org-policies set-custom-constraint CONSTRAINT_PATH

Remplacez CONSTRAINT_PATH par le chemin d'accès complet à votre fichier de contrainte personnalisée. Par exemple, /home/user/customconstraint.yaml.

Une fois l'opération terminée, vos contraintes personnalisées sont disponibles en tant que règles d'administration dans votre liste de règles d'administration Google Cloud .

Pour vérifier que la contrainte personnalisée existe, utilisez la commande gcloud org-policies list-custom-constraints :

      gcloud org-policies list-custom-constraints --organization=ORGANIZATION_ID

Remplacez ORGANIZATION_ID par l'ID de votre ressource d'organisation.

Pour en savoir plus, consultez Afficher les règles d'administration.

Appliquer une règle d'administration personnalisée

Vous pouvez appliquer une contrainte en créant une règle d'administration qui y fait référence, puis en appliquant cette règle à une ressource Google Cloud .

Console

Dans la console Google Cloud , accédez à la page Règles d'administration.
Accéder à la page Règles d'administration
Dans le sélecteur de projets, choisissez le projet pour lequel vous souhaitez définir la règle d'administration.
Dans la liste de la page Règles d'administration, sélectionnez votre contrainte pour afficher la page Détails de la règle propres à cette contrainte.
Pour personnaliser la règle d'administration pour cette ressource, cliquez sur Gérer la règle.
Sur la page Modifier la stratégie, sélectionnez Ignorer la règle parente.
Cliquez sur Ajouter une règle.
Dans la section Application, indiquez si cette règle d'administration est appliquée ou non.
Facultatif : pour rendre la règle d'administration conditionnelle à un tag, cliquez sur Ajouter une condition. Notez que si vous ajoutez une règle conditionnelle à une règle d'administration, vous devez ajouter au moins une règle non conditionnelle, sinon la règle ne pourra pas être enregistrée. Pour en savoir plus, consultez Définir une règle d'administration avec des tags.
Cliquez sur Tester les modifications pour simuler l'effet de la règle d'administration. Pour en savoir plus, consultez Tester les modifications apportées aux règles d'administration à l'aide de Policy Simulator.
Pour appliquer la règle d'administration en mode de simulation, cliquez sur Définir la règle de dry run. Pour en savoir plus, consultez Créer une règle d'administration en mode dry run.
Une fois que vous avez vérifié que la règle d'administration en mode dry run fonctionne comme prévu, définissez la règle active en cliquant sur Définir la règle.

gcloud

Pour créer une règle d'administration avec des règles booléennes, créez un fichier YAML de règle qui fait référence à la contrainte :

        name: projects/PROJECT_ID/policies/CONSTRAINT_NAME
        spec:
          rules:
          - enforce: true
        
        dryRunSpec:
          rules:
          - enforce: true

Remplacez les éléments suivants :

PROJECT_ID : projet sur lequel vous souhaitez appliquer votre contrainte.
CONSTRAINT_NAME : nom que vous avez défini pour la contrainte personnalisée. Exemple : custom.allowEmailLinkLogin.

Pour appliquer la règle d'administration en mode dry run, exécutez la commande suivante avec le flag dryRunSpec :

        gcloud org-policies set-policy POLICY_PATH \
          --update-mask=dryRunSpec

Remplacez POLICY_PATH par le chemin d'accès complet au fichier YAML de votre règle d'administration. L'application de la règle peut prendre jusqu'à 15 minutes.

Après avoir vérifié que la règle d'administration en mode dry run fonctionne comme prévu, définissez la règle active avec la commande org-policies set-policy et le flag spec :

        gcloud org-policies set-policy POLICY_PATH \
          --update-mask=spec

Remplacez POLICY_PATH par le chemin d'accès complet au fichier YAML de votre règle d'administration. L'application de la règle peut prendre jusqu'à 15 minutes.

Tester la règle d'administration personnalisée

Pour tester la règle d'administration personnalisée, essayez d'activer le multitenancy pour le projet :

curl -i -X PATCH \
-H 'Content-Type: application/json' \
-H "Authorization: Bearer $(gcloud auth print-access-token)" \
-d '
{
  "sign_in": {"email": {"password_required": false}}
}' https://autopush-identitytoolkit.sandbox.googleapis.com/admin/v2/projects/shimingz-playground-1/config\?update_mask\=sign_in.email.password_required

La sortie doit se présenter comme suit :

Operation denied by custom org policies: ["customConstraints/custom.allowEmailLinkLogin": "Cannot disable email link login."]

Ressources et opérations compatibles avec Identity Platform

Identity Platform est compatible avec les ressources suivantes pour les règles d'administration personnalisées :

Champs non compatibles

Les champs suivants ne sont pas acceptés, car ils concernent la sécurité de votre ressource :

identitytoolkit.googleapis.com/Config:
- resource.notification.send_email.smtp.password
identitytoolkit.googleapis.com/DefaultSupportedIdpConfig:
- resource.client_secret
identitytoolkit.googleapis.com/OauthIdpConfig:
- resource.client_secret

Exemples de règles d'administration personnalisées pour des cas d'utilisation courants

Le tableau suivant fournit la syntaxe de certaines règles d'administration personnalisées qui pourraient vous être utiles :

Description	Syntaxe de la contrainte
Ne désactivez pas la connexion par e-mail pour l'application.	name: organizations/`ORGANIZATION_ID`/customConstraints/custom.enableEmailLogin resourceTypes: - identitytoolkit.googleapis.com/Config methodTypes: - CREATE - UPDATE condition: "resource.signIn.email.enabled == true" actionType: ALLOW displayName: Enable email login description: All applications must have email login enabled.
Autoriser la connexion avec Google uniquement avec un ID client Google spécifique	name: organizations/`ORGANIZATION_ID`/customConstraints/custom.denyUnexpectedGoogleClientId resourceTypes: - identitytoolkit.googleapis.com/DefaultSupportedIdpConfig methodTypes: - CREATE - UPDATE condition: "resource.name.contains('google.com') && !resource.client_id == 'my-client-id'" actionType: DENY displayName: Only allow login with Google with specific Google client ID description: Only allow login with Google with specific Google client ID for all applications.
Autoriser uniquement une entité SAML spécifique	name: organizations/`ORGANIZATION_ID`/customConstraints/custom.allowSpecificSamlEntity resourceTypes: - identitytoolkit.googleapis.com/InboundSamlConfig methodTypes: - CREATE - UPDATE condition: "resource.idp_config.idp_entity_id == 'my-saml-entity-id'" actionType: ALLOW displayName: Only allow a specific SAML entity description: Only allow a specific SAML entity for applications in this organization.
Autoriser l'IdP OIDC avec le flux de code	name: organizations/`ORGANIZATION_ID`/customConstraints/custom.allowOauthIdpWithCodeFlow resourceTypes: - identitytoolkit.googleapis.com/OauthIdpConfig methodTypes: - CREATE - UPDATE condition: "resource.response_type.code == true" actionType: ALLOW displayName: Allow OIDC IdP with code flow description: All OIDC IdP must use code flow.
Autoriser les régions pour les SMS aux États-Unis	name: organizations/`ORGANIZATION_ID`/customConstraints/custom.allowSmsRegion resourceTypes: - identitytoolkit.googleapis.com/Tenant methodTypes: - CREATE - UPDATE condition: "resource.sms_region_config.allow_by_default.disallowed_regions.exists(disallowed_region, disallowed_region != 'US')" actionType: DENY displayName: Allow SMS region in US description: Only allow SMS to be operated in the US for all applications.

Étapes suivantes

Pour en savoir plus sur les règles d'administration, consultez la page Présentation du service de règles d'administration.
Découvrez comment créer et gérer des règles d'administration.
Consultez la liste complète des contraintes prédéfinies liées aux règles d'administration.