Ajouter un domaine à la liste d'autorisation

Cette page explique comment ajouter un domaine à la liste d'autorisation à l'aide de l'API Allowlisted Domains.

Avant de commencer

• Consultez la présentation de l'API Allowlisted Domains.
• Configurez l'API Allowlisted Domains.

Remarques importantes

• Conception immuable : les noms de domaine ne pouvant pas être modifiés, les mises à jour doivent être effectuées en supprimant l'entrée existante et en en créant une autre.
• Débit : le système accepte un quota d'environ une requête par seconde (RPS) partagée entre tous les domaines pour n'importe quel compte client unique.
• Capacité : les administrateurs peuvent ajouter jusqu'à 5 000 domaines pour un seul compte client.

Ajouter un domaine à la liste d'autorisation

Utilisez la méthode create pour ajouter une entrée. Cette mutation est asynchrone et renvoie une opération de longue durée.

Python

def create_allowlisted_domain(service, domain_name):
  """Creates an allowlisted domain."""
  try:
    payload = {'domain': domain_name}
    response = service.allowlistedDomains().create(body=payload).execute()
    return response
  except Exception as e:
    print(f'An error occurred during create: {e}')
    return None

Traitement des erreurs

Condition d'erreur	Code d'état RPC	Message d'erreur	Dépannage / Justification
Non autorisé à accéder à la ressource	PERMISSION_DENIED (403)	"Permission denied for allowlisted domain resource."	• Assurez-vous que l'utilisateur dispose du champ d'application approprié. • Assurez-vous que l'utilisateur dispose de l'autorisation requise. • Contactez l'adresse e-mail de contact pour vérifier si le projet/l'utilisateur a été ajouté à la liste d'autorisation ou non.
ID client introuvable pour l'utilisateur	NOT_FOUND (404)	"Customer ID not found for user."	L'utilisateur connecté n'est pas associé à un domaine valide.
Une mise à jour de la liste d'autorisation est déjà en cours.	FAILED_PRECONDITION (400)	"An allowlist update is already in progress. Please wait for it to complete before making another request."	Attendez que les mutations précédentes soient terminées.
La limite de domaines dans la liste d'autorisation a été atteinte.	FAILED_PRECONDITION (400)	"Allowlisted domain limit has been reached."	La capacité maximale de 5 000 domaines a été atteinte pour le compte client. Vous ne pouvez plus ajouter de domaines.
Nom de domaine vide	INVALID_ARGUMENT (400)	"Domain name cannot be empty."	Vérifiez le domaine transmis à la requête de création. Il ne doit pas être vide.
Nom de domaine non valide	INVALID_ARGUMENT (400)	"Invalid domain name: <domain>."	Le nom de domaine fourni dans la requête est mal formé ou non valide. Cette erreur se produit généralement dans l'un des cas suivants : • Non-validité syntaxique : le nom de domaine n'est pas conforme aux normes de mise en forme requises. • Domaines restreints : les domaines spécifiques suivants sont restreints et ne peuvent pas être ajoutés à la liste d'autorisation : • aol.com • gmail.com • hotmail.com • mail.ru • outlook.com • web.de • yahoo.com • yandex.com • yandex.ru

Journaux d'audit

Les créations à l'aide de l'API Allowlisted Domains génèrent des événements de journal d'audit que les administrateurs peuvent examiner. Pour plus d'informations, consultez la section Afficher les journaux d'audit.