Elenco e recupero dei domini inclusi nella lista consentita

Questa pagina fornisce esempi di codice e dettagli operativi che mostrano come elencare e recuperare domini specifici nella lista consentita utilizzando l'API Domini inclusi nella lista consentita.

Prima di iniziare

Esegui le seguenti attività prima di procedere con le informazioni riportate in questa pagina:

Elenco dei domini nella lista consentita

Utilizza il metodo list per recuperare tutte le voci. Facoltativamente, puoi fornire una stringa pageSize, pageToken o filter per restringere i risultati.

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

Recupero di un dominio specifico

Recupera in modo sincrono un dominio specifico utilizzando il nome della risorsa ottenuto da un'operazione di elenco precedente.

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

Gestione degli errori

Questa sezione descrive le condizioni di errore comuni e i passaggi per la risoluzione dei problemi durante l'elenco o il recupero dei domini inclusi nella lista consentita.

Gestione degli errori di elenco

Condizione di errore Codice di stato RPC Messaggio di errore Risoluzione dei problemi / Giustificazione
Non hai l'autorizzazione per la risorsa PERMISSION_DENIED (403) "Permission denied for allowlisted domain resource." • Assicurati che all'utente sia stato concesso l'ambito appropriato.
• Assicurati che l'utente disponga dell'autorizzazione richiesta.
• Contatta l'indirizzo email di contatto per verificare se il progetto/utente è stato incluso nella lista consentita.
ID cliente non trovato per l'utente NOT_FOUND (404) "Customer ID not found for user." L'utente che ha eseguito l'accesso non è collegato a un dominio valido.
L'elenco è stato modificato durante la paginazione ABORTED "List has been mutated. Please restart pagination." L'elenco sottostante dei domini è stato modificato (mutato) durante la paginazione; devi riavviare l'operazione allowlistedDomains.list dalla prima pagina. Valuta la possibilità di recuperare l'elenco completo contemporaneamente se sono in corso mutazioni in parallelo.
Valore del filtro del dominio non valido fornito INVALID_ARGUMENT (400) "Invalid domain filter value provided. Error: <Error message>." Controlla il dominio fornito nel parametro del filtro della richiesta di elenco per assicurarti che non sia vuoto o sintatticamente non valido.
Casi di parametri di filtro non validi forniti:
L'operazione allowlistedDomains.list non è riuscita a causa di una sintassi non valida o di un'operazione non supportata passata nel filtro. Il messaggio di errore spiegherà il caso d'uso esatto. Assicurati di utilizzare il seguente formato per chiamare l'API:
GET https://cloudidentity.googleapis.com/v1/allowlistedDomains?filter="domain = 'google.com'"
Espressione di filtro non valida INVALID_ARGUMENT (400) "Invalid filter expression: %s." Espressione di filtro non corretta passata nella richiesta.
Condizioni composite non supportate INVALID_ARGUMENT (400) "Composite conditions (AND, OR, NOT) are not supported in the filter." Il filtro non supporta le condizioni composite; è consentito solo il filtro a condizione singola.
È supportato solo l'operatore "=" INVALID_ARGUMENT (400) "Only '=' operator is supported in the filter." Utilizza l'operatore di uguaglianza (=) per tutte le espressioni di filtro. Non sono supportate altre operazioni.
È supportato solo il campo "domain" INVALID_ARGUMENT (400) "Only 'domain' field is supported in the filter." Il filtro deve essere destinato al campo del dominio (ad es. domain = 'example.com'). Non sono supportati altri campi.
Il lato destro ha un valore membro non valido / deve essere una stringa INVALID_ARGUMENT (400) "RHS of filter expression has invalid member value."
"RHS of filter expression should be a string."		 Il valore del lato destro dell'espressione di filtro deve essere una stringa (il nome di dominio).
La dimensione della pagina è negativa INVALID_ARGUMENT (400) "Page size cannot be negative." Assicurati che il parametro pageSize sia un numero intero non negativo.
Token di pagina non valido INVALID_ARGUMENT (400) "Invalid page token." L'errore indica che il token non è nel formato corretto o è scaduto. Assicurati di utilizzare il token esatto e non modificato fornito dal campo nextPageToken della risposta dell'elenco precedente immediata. Se la convalida non riesce, ometti il parametro pageToken per riavviare la paginazione dalla prima pagina.

Gestione degli errori di recupero

Condizione di errore Codice di stato RPC Messaggio di errore Risoluzione dei problemi / Giustificazione
Non hai l'autorizzazione per la risorsa PERMISSION_DENIED (403) "Permission denied for allowlisted domain resource." • Assicurati che all'utente sia stato concesso l'ambito appropriato.
• Assicurati che l'utente disponga dell'autorizzazione richiesta.
• Contatta l'indirizzo email di contatto per verificare se il progetto/utente è stato incluso nella lista consentita.
ID cliente non trovato per l'utente NOT_FOUND (404) "Customer ID not found for user." L'utente che ha eseguito l'accesso non è collegato a un dominio valido.
Dominio non trovato nella lista consentita NOT_FOUND (404) "Allowlisted domain <domain> not found" Il dominio fornito non esiste nella lista consentita.
Il nome della risorsa non è valido INVALID_ARGUMENT (400) "Invalid resource name: <resourceName>." Convalida il formato del nome della risorsa: la stringa utilizzata per il parametro name deve seguire esattamente il formato allowlistedDomains/UNIQUE_IDENTIFIER.