Method: projects.locations.userStores.userLicenses.list

사용자 라이선스를 나열합니다.

HTTP 요청

GET https://discoveryengine.googleapis.com/v1beta/{parent=projects/*/locations/*/userStores/*}/userLicenses

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

경로 매개변수

매개변수
parent

string

(필수 항목) 상위 UserStore 리소스 이름이며, 형식은 projects/{project}/locations/{location}/userStores/{userStoreId}입니다.

쿼리 파라미터

파라미터
pageSize

integer

(선택사항) 요청한 페이지 크기입니다. 서버에서 요청한 것보다 적은 항목을 반환할 수 있습니다. 지정하지 않으면 기본적으로 10입니다. 최댓값은 50이며, 50을 초과하는 값은 50으로 변환됩니다.

이 필드가 음수이면 INVALID_ARGUMENT 오류가 반환됩니다.
pageToken

string

(선택사항) 이전 userLicenses.list 호출에서 받은 페이지 토큰입니다. 후속 페이지를 검색하려면 이를 입력합니다.

페이지를 매길 때 userLicenses.list에 제공된 다른 모든 매개 변수는 페이지 토큰을 제공한 호출과 일치해야 합니다.
filter

string

(선택사항) 목록 요청을 필터링합니다.

지원되는 필드:

  • licenseAssignmentState
  • userPrincipal * 예:

  • licenseAssignmentState = ASSIGNED: 할당된 사용자 라이선스를 나열합니다.

  • licenseAssignmentState = NO_LICENSE: 라이선스가 없는 사용자를 나열합니다.
  • licenseAssignmentState = NO_LICENSE_ATTEMPTED_LOGIN: 로그인 시도했지만 라이선스가 할당되지 않은 사용자를 나열합니다.
  • licenseAssignmentState != NO_LICENSE_ATTEMPTED_LOGIN: 로그인 시도했지만 라이선스가 할당되지 않은 사용자를 필터링합니다.
  • userPrincipal = user1@abc.com의 사용자 라이선스를 나열합니다.user1@abc.com
orderBy

string

(선택사항) UserLicense가 나열되는 순서입니다. 값은 쉼표로 구분된 필드 목록이어야 합니다. 기본 정렬 순서는 오름차순입니다. 필드에서 내림차순으로 지정하려면 ' desc' 서픽스를 추가합니다. 구문에서 중복된 공백 문자는 중요하지 않습니다.

지원되는 필드 (현재는 userPrincipal만 지원됨):

  • userPrincipal

설정하지 않으면 기본 정렬은 userPrincipal입니다.

예:

  • userPrincipal: userPrincipal을 기준으로 오름차순으로 정렬합니다.
  • userPrincipal desc를 기준으로 내림차순으로 정렬합니다.userPrincipal

요청 본문

요청 본문은 비어 있어야 합니다.

응답 본문

UserLicenseService.ListUserLicenses의 응답 메시지입니다.

성공한 경우 응답 본문은 다음과 같은 구조의 데이터를 포함합니다.

JSON 표현 
{
  "userLicenses": [
    {
      object (UserLicense)
    }
  ],
  "nextPageToken": string
}
필드
userLicenses[]

object (UserLicense)

모든 고객의 UserLicense입니다.
nextPageToken

string

다음 페이지를 검색하기 위해 pageToken으로 전송할 수 있는 토큰입니다. 이 필드를 생략하면 후속 페이지가 표시되지 않습니다.

승인 범위

다음 OAuth 범위 중 하나가 필요합니다.

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

자세한 내용은 Authentication Overview에서 확인하세요.

IAM 권한

parent 리소스에 대해서는 다음 IAM 권한이 필요합니다.

  • discoveryengine.userStores.listUserLicenses

자세한 내용은 IAM 문서를 참조하세요.