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에 제공된 다른 모든 매개 변수는 페이지 토큰을 제공한 호출과 일치해야 합니다.
orderBy

string

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

지원되는 필드:

  • licenseAssignmentState
  • userPrincipal
  • userProfile
  • last_login_date
  • updateTime

설정되지 않은 경우 기본 순서는 userPrincipal입니다.

예:

  • userPrincipal desc를 사용하여 userPrincipal 기준으로 내림차순으로 정렬합니다.
  • licenseAssignmentState: licenseAssignmentState을 기준으로 오름차순으로 정렬합니다.
  • last_login_date desc를 사용하여 last_login_date 기준으로 내림차순으로 정렬합니다.
  • updateTime desc를 사용하여 updateTime 기준으로 내림차순으로 정렬합니다.
  • last_login_date desc, userPrincipal를 사용하여 last_login_date에 따라 내림차순으로 정렬한 다음 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

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

IAM 권한

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

  • discoveryengine.userStores.listUserLicenses

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