Method: projects.accounts.query

요청의 조건에 따라 프로젝트 또는 테넌트 내에서 사용자 계정을 조회합니다.

HTTP 요청

POST https://identitytoolkit.googleapis.com/v1/projects/{targetProjectId}/accounts:query

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

경로 매개변수

매개변수
targetProjectId

string

결과의 범위가 지정된 프로젝트의 ID입니다.

승인을 처리하려면 지정된 리소스 targetProjectId에 대해 다음과 같은 IAM 권한이 필요합니다.

  • firebaseauth.users.get

요청 본문

요청 본문에는 다음과 같은 구조의 데이터가 포함됩니다.

JSON 표현
{
  "returnUserInfo": boolean,
  "limit": string,
  "offset": string,
  "sortBy": enum (SortByField),
  "order": enum (Order),
  "tenantId": string,
  "expression": [
    {
      object (SqlExpression)
    }
  ]
}
필드
returnUserInfo

boolean

true인 경우 이 요청은 검색어와 일치하는 계정을 반환합니다. false인 경우 쿼리와 일치하는 계정의 개수만 반환됩니다. 기본값은 true입니다.

limit

string (int64 format)

반환할 계정의 최대 개수로, 상한값은 500입니다. 기본값은 500입니다. returnUserInfotrue로 설정된 경우에만 유효합니다.

offset

string (int64 format)

일치하는 레코드의 시작 부분부터 건너뛸 계정 수입니다. returnUserInfotrue로 설정된 경우에만 유효합니다.

sortBy

enum (SortByField)

order

enum (Order)

tenantId

string

결과의 범위가 지정된 테넌트의 ID입니다.

expression[]

object (SqlExpression)

응답 본문

성공한 경우 응답 본문에 QueryUserInfoResponse의 인스턴스가 포함됩니다.

승인 범위

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

  • https://www.googleapis.com/auth/identitytoolkit
  • https://www.googleapis.com/auth/firebase
  • https://www.googleapis.com/auth/cloud-platform

자세한 내용은 Authentication Overview를 참고하세요.