Method: projects.locations.completeExternalIdentities

このメソッドは、指定された接頭辞に基づいて、外部 ID プロバイダで管理されているユーザーとグループの候補を提供します。

HTTP リクエスト

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

この URL は gRPC Transcoding 構文を使用します。

パスパラメータ

パラメータ
parent

string

必須。親ロケーションのリソース名（projects/*/locations/global など）。

クエリ パラメータ

パラメータ
prefixQuery

string

必須。検索する接頭辞。ユーザーの場合、この接頭辞は primaryEmail と照合されます。グループの場合、この接頭辞は displayName と照合されます。照合では大文字と小文字が区別されません。
maxSuggestions

integer

省略可。返されるユーザーとグループの結果の最大数。サービスから返される数は、この値より少ない場合があります。

指定しない場合は、最大 6 件の結果が返されます。上限は、ユーザーとグループの間でできるだけ均等に分散されます。たとえば、maxSuggestions が 7 の場合、サービスは 4 人のユーザーと 3 つのグループを返すことがあります。一方のタイプの候補数が上限の半分未満の場合、もう一方のタイプは maxSuggestions の上限まで候補を返すことがあります。
entityTypeFilter

enum (EntityTypeFilter)

省略可。取得するエンティティのタイプ。設定しない場合は、すべてのエンティティ タイプが返されます。
useScimIdentities

boolean

省略可。外部 ID の補完に scim ID を使用するかどうか。false の場合、Microsoft Graph API を呼び出して外部 ID を取得します。

リクエストの本文

リクエストの本文は空にする必要があります。

レスポンスの本文

CompletionService.CompleteExternalIdentities に対するレスポンス メッセージです。

成功した場合、レスポンスの本文には次の構造のデータが含まれます。

JSON 表現 
{
  "externalIdentities": [
    {
      object (ExternalIdentity)
    }
  ]
}
フィールド
externalIdentities[]

object (ExternalIdentity)

クエリに一致する外部 ID のリスト。

認可スコープ

次の OAuth スコープのいずれかが必要です。

  • 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

詳細については、Authentication Overview をご覧ください。

IAM 権限

parent リソースに対する次の IAM 権限が必要です。

  • discoveryengine.locations.completeExternalIdentities

詳細については、IAM のドキュメントをご覧ください。

EntityTypeFilter

取得するエンティティのタイプ。

列挙型
ENTITY_TYPE_FILTER_UNSPECIFIED エンティティ タイプ フィルタが指定されていません。
USERS ユーザーのみを取得します。
GROUPS グループのみを取得します。

ExternalIdentity

ユーザーまたはグループを表す外部 ID。このユーザーまたはグループは、外部 ID プロバイダ（IdP）のものです。

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.
}
フィールド
externalId

string

エンティティ（ユーザーまたはグループ）の一意のサードパーティ ID（externalId）。
displayName

string

ユーザーまたはグループの表示名。
共用体フィールド EntityType。外部 ID のタイプ。これは、エンティティ（ユーザーまたはグループ）のタイプと対応するメタデータを示すために使用されます。EntityType は次のいずれかになります。
userMetadata

object (UserMetadata)

外部ユーザーに対応するメタデータ。
groupMetadata

object (GroupMetadata)

外部ユーザーに対応するメタデータ。

UserMetadata

外部ユーザーに対応するメタデータ。

JSON 表現 
{
  "givenName": string,
  "familyName": string,
  "primaryEmail": string
}
フィールド
givenName

string

ユーザーの名。
familyName

string

ユーザーの姓。
primaryEmail

string

ユーザーのメインのメールアドレス。

GroupMetadata

この型にはフィールドがありません。

外部グループに対応するメタデータ。