Répertorier et obtenir les domaines ajoutés à la liste d'autorisation

Cette page fournit des exemples de code et des détails opérationnels qui montrent comment répertorier et récupérer des domaines spécifiques dans la liste d'autorisation à l'aide de l'API Allowlisted Domains.

Avant de commencer

Effectuez les tâches suivantes avant d'utiliser les informations fournies sur cette page :

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

Répertorier les domaines dans la liste d'autorisation

Utilisez la méthode list pour récupérer toutes les entrées. Vous pouvez éventuellement fournir pageSize, pageToken ou une chaîne filter pour affiner les résultats.

Python

def list_allowlisted_domains(
    service, page_size=None, page_token=None, domain_filter=None
):
  """Lists allowlisted domains."""
  try:
    filter_string = None
    if domain_filter:
      filter_string = f"domain = '{domain_filter}'"

    response = (
        service.allowlistedDomains()
        .list(
            pageSize=page_size, pageToken=page_token, filter=filter_string
        )
        .execute()
    )
    return response
  except Exception as e:
    print(f'An error occurred during list: {e}')
    return None

Remarque : Le filtrage n'est compatible qu'avec les correspondances exactes sur la chaîne de domaine (par exemple, filter="domain = 'google.com'"). Aucune condition composite n'est acceptée.

Obtenir un domaine spécifique

Récupérez un domaine spécifique de manière synchrone à l'aide de son nom de ressource obtenu à partir d'une opération de liste précédente.

Python

def get_allowlisted_domain(service, resource_name):
  """Gets an allowlisted domain."""
  if not resource_name:
    print('Resource name is missing.')
    return None

  try:
    response = service.allowlistedDomains().get(name=resource_name).execute()
    return response
  except Exception as e:
    print(f'An error occurred during get: {e}')
    return None

Traitement des erreurs

Cette section décrit les conditions d'erreur courantes et les étapes de dépannage lors de la liste ou de l'obtention de domaines ajoutés à la liste d'autorisation.

Traitement des erreurs de liste

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.
La liste a été modifiée lors de la pagination	ABORTED	"List has been mutated. Please restart pagination."	La liste de domaines sous-jacente a été modifiée (mutée) pendant que vous paginiez. Vous devez redémarrer l'opération allowlistedDomains.list à partir de la première page. Envisagez de récupérer la liste complète en une seule fois si des mutations sont en cours en parallèle.
Valeur de filtre de domaine non valide fournie	INVALID_ARGUMENT (400)	"Invalid domain filter value provided. Error: <Error message>."	Vérifiez le domaine fourni dans le paramètre de filtre de la requête de liste pour vous assurer qu'il n'est pas vide ou syntaxiquement incorrect. Cas de paramètres de filtre non valides fournis : L'opération allowlistedDomains.list a échoué en raison d'une syntaxe non valide ou d'une opération non compatible transmise dans le filtre. Le message d'erreur explique le cas d'utilisation exact. Veuillez vous assurer que le format suivant est utilisé pour appeler l'API : GET https://cloudidentity.googleapis.com/v1/allowlistedDomains?filter="domain = 'google.com'"
Expression de filtre non valide	INVALID_ARGUMENT (400)	"Invalid filter expression: %s."	Expression de filtre incorrecte transmise dans la requête.
Conditions composites non acceptées	INVALID_ARGUMENT (400)	"Composite conditions (AND, OR, NOT) are not supported in the filter."	Le filtre n'est pas compatible avec les conditions composites. Seul le filtrage à condition unique est autorisé.
Seul l'opérateur "=" est accepté	INVALID_ARGUMENT (400)	"Only '=' operator is supported in the filter."	Utilisez l'opérateur d'égalité (=) pour toutes les expressions de filtre. Aucune autre opération n'est acceptée.
Seul le champ "domain" est accepté	INVALID_ARGUMENT (400)	"Only 'domain' field is supported in the filter."	Le filtre doit cibler le champ de domaine (par exemple, domain = 'example.com'). Aucun autre champ n'est accepté.
La partie droite contient une valeur de membre non valide / doit être une chaîne	INVALID_ARGUMENT (400)	"RHS of filter expression has invalid member value." "RHS of filter expression should be a string."	La valeur de la partie droite de l'expression de filtre doit être une chaîne (le nom de domaine).
La taille de la page est négative	INVALID_ARGUMENT (400)	"Page size cannot be negative."	Assurez-vous que le paramètre pageSize est un entier non négatif.
Jeton de page non valide	INVALID_ARGUMENT (400)	"Invalid page token."	L'erreur indique que le jeton est mal formé ou a expiré. Assurez-vous d'utiliser le jeton exact et non modifié fourni par le champ nextPageToken de la réponse de liste précédente immédiate. Si la validation échoue, omettez le paramètre pageToken pour redémarrer la pagination à partir de la première page.

Traitement des erreurs d'obtention

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.
Domaine introuvable dans la liste d'autorisation	NOT_FOUND (404)	"Allowlisted domain <domain> not found"	Le domaine fourni n'existe pas dans la liste d'autorisation.
Nom de ressource non valide	INVALID_ARGUMENT (400)	"Invalid resource name: <resourceName>."	Valider le format du nom de ressource : la chaîne utilisée pour le paramètre name doit suivre précisément le format allowlistedDomains/UNIQUE_IDENTIFIER.