Method: users.settings.cse.identities.list

Wyświetla tożsamości zaszyfrowane po stronie klienta dla uwierzytelnionego użytkownika.

W przypadku administratorów zarządzających tożsamościami i parami kluczy użytkowników w swojej organizacji żądania wymagają autoryzacji za pomocą konta usługi, które ma uprawnienia do delegowania w całej domenie, aby podszywać się pod użytkowników w zakresie https://www.googleapis.com/auth/gmail.settings.basic.

W przypadku użytkowników zarządzających własnymi tożsamościami i parami kluczy wymagane jest włączenie i skonfigurowanie szyfrowania za pomocą kluczy sprzętowych.

Żądanie HTTP

GET https://gmail.googleapis.com/gmail/v1/users/{userId}/settings/cse/identities

Adres URL używa składni transkodowania gRPC.

Parametry ścieżki

Parametry
userId

string

Podstawowy adres e-mail osoby przesyłającej prośbę. Aby wskazać uwierzytelnionego użytkownika, możesz użyć wartości specjalnej me.

Parametry zapytania

Parametry
pageToken

string

Token stronicowania wskazujący, którą stronę tożsamości należy zwrócić. Jeśli token nie zostanie podany, interfejs API zwróci pierwszą stronę wyników.

pageSize

integer

Liczba tożsamości do zwrócenia. Jeśli nie podasz tej wartości, domyślny rozmiar strony wyniesie 20 pozycji.

Treść żądania

Treść żądania musi być pusta.

Treść odpowiedzi

W przypadku powodzenia treść żądania zawiera dane o następującej strukturze:

Zapis JSON
{
  "cseIdentities": [
    {
      object (CseIdentity)
    }
  ],
  "nextPageToken": string
}
Pola
cseIdentities[]

object (CseIdentity)

Jedna strona listy tożsamości CSE skonfigurowanych dla użytkownika.

nextPageToken

string

Token stronicowania, który należy przekazać do kolejnego wywołania identities.list, aby pobrać następną stronę tożsamości. Jeśli ta wartość nie zostanie zwrócona lub będzie pustym ciągiem, nie będzie już kolejnych stron.

Zakresy autoryzacji

Wymaga jednego z tych zakresów OAuth:

  • https://www.googleapis.com/auth/gmail.settings.basic
  • https://mail.google.com/
  • https://www.googleapis.com/auth/gmail.modify
  • https://www.googleapis.com/auth/gmail.readonly
  • https://www.googleapis.com/auth/gmail.settings.sharing

Więcej informacji znajdziesz w sekcji OAuth 2.0 Overview.