Method: projects.locations.completeExternalIdentities

이 메서드는 제공된 접두사를 기반으로 외부 ID 공급자에서 관리되는 사용자 및 그룹에 대한 추천을 제공합니다.

HTTP 요청

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

URL은 gRPC 트랜스코딩 문법을 사용합니다.

경로 매개변수

매개변수
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

이 유형에는 필드가 없습니다.

외부 그룹에 해당하는 메타데이터입니다.