Method: projects.locations.completeExternalIdentities

Metode ini memberikan saran untuk pengguna dan grup yang dikelola di penyedia identitas eksternal, berdasarkan awalan yang diberikan.

Permintaan HTTP

GET https://discoveryengine.googleapis.com/v1alpha/{parent=projects/*/locations/*}:completeExternalIdentities

URL menggunakan sintaks gRPC Transcoding.

Parameter jalur

Parameter
parent

string

Wajib. Nama resource lokasi induk, seperti projects/*/locations/global.

Parameter kueri

Parameter
prefixQuery

string

Wajib. Awalan yang akan ditelusuri. Untuk pengguna, awalan ini dicocokkan dengan primaryEmail. Untuk grup, awalan ini dicocokkan dengan displayName. Pencocokan tidak peka huruf besar/kecil.
maxSuggestions

integer

Opsional. Jumlah maksimum hasil pengguna dan grup yang akan ditampilkan. Layanan mungkin menampilkan lebih sedikit dari nilai ini.

Jika tidak ditentukan, paling banyak 6 hasil akan ditampilkan. Batas didistribusikan secara merata kepada pengguna dan grup. Misalnya, jika maxSuggestions adalah 7, layanan dapat menampilkan 4 pengguna dan 3 grup. Jika jumlah saran dari satu jenis kurang dari setengah batas, jenis lainnya dapat menampilkan lebih banyak saran hingga batas maxSuggestions.
entityTypeFilter

enum (EntityTypeFilter)

Opsional. Jenis entitas yang akan diambil. Jika tidak ditetapkan, semua jenis entity akan ditampilkan.
useScimIdentities

boolean

Opsional. Apakah akan menggunakan identitas scim untuk penyelesaian identitas eksternal. Jika salah (false), kita akan memanggil Microsoft Graph API untuk mengambil identitas eksternal.

Isi permintaan

Isi permintaan harus kosong.

Isi respons

Pesan respons untuk CompletionService.CompleteExternalIdentities.

Jika berhasil, isi respons memuat data dengan struktur berikut:

Representasi JSON 
{
  "externalIdentities": [
    {
      object (ExternalIdentity)
    }
  ]
}
Kolom
externalIdentities[]

object (ExternalIdentity)

Daftar identitas eksternal yang cocok dengan kueri.

Cakupan otorisasi

Memerlukan salah satu cakupan OAuth berikut:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/discoveryengine.assist.readwrite
  • https://www.googleapis.com/auth/discoveryengine.readwrite
  • https://www.googleapis.com/auth/discoveryengine.serving.readwrite

Untuk mengetahui informasi selengkapnya, lihat Authentication Overview.

Izin IAM

Memerlukan izin IAM berikut pada resource parent:

  • discoveryengine.locations.completeExternalIdentities

Untuk mengetahui informasi selengkapnya, lihat dokumentasi IAM.

EntityTypeFilter

Jenis entitas yang akan diambil.

Enum
ENTITY_TYPE_FILTER_UNSPECIFIED Filter jenis entitas tidak ditentukan.
USERS Hanya ambil pengguna.
GROUPS Hanya mengambil grup.

ExternalIdentity

Identitas eksternal yang merepresentasikan pengguna atau grup. Pengguna atau grup ini berasal dari penyedia identitas (IdP) eksternal.

Representasi JSON 
{
  "externalId": string,
  "displayName": string,

  // Union field EntityType can be only one of the following:
  "userMetadata": {
    object (UserMetadata)
  },
  "groupMetadata": {
    object (GroupMetadata)
  }
  // End of list of possible types for union field EntityType.
}
Kolom
externalId

string

ID pihak ketiga(externalId) unik dari entitas (pengguna atau grup).
displayName

string

Nama tampilan pengguna atau grup.
Kolom union EntityType. Jenis identitas eksternal. Objek ini digunakan untuk menunjukkan jenis entitas (pengguna atau grup) dan metadata yang sesuai. EntityType hanya ada berupa salah satu diantara berikut:
userMetadata

object (UserMetadata)

metadata yang sesuai dengan pengguna eksternal.
groupMetadata

object (GroupMetadata)

metadata yang sesuai dengan pengguna eksternal.

UserMetadata

metadata yang sesuai dengan pengguna eksternal.

Representasi JSON 
{
  "givenName": string,
  "familyName": string,
  "primaryEmail": string
}
Kolom
givenName

string

Nama depan pengguna.
familyName

string

Nama keluarga pengguna.
primaryEmail

string

Alamat email utama pengguna.

GroupMetadata

Jenis ini tidak memiliki kolom.

metadata yang sesuai dengan grup eksternal.