batchGet method

Future<GoogleCloudIdentitytoolkitV1DownloadAccountResponse> batchGet(String targetProjectId, String tenantId, { String? delegatedProjectNumber, int? maxResults, String? nextPageToken, String? $fields, })

Download account information for all accounts on the project in a paginated manner.

To use this method requires a Google OAuth 2.0 credential with proper permissions.. Furthermore, additional permissions are needed to get password hash, password salt, and password version from accounts; otherwise these fields are redacted.

Request parameters:

targetProjectId - If tenant_id is specified, the ID of the Google Cloud project that the Identity Platform tenant belongs to. Otherwise, the ID of the Google Cloud project that the accounts belong to. Value must have pattern ^\[^/\]+$.

tenantId - The ID of the Identity Platform tenant the accounts belongs to. If not specified, accounts on the Identity Platform project are returned. Value must have pattern ^\[^/\]+$.

delegatedProjectNumber - null

maxResults - The maximum number of results to return. Must be at least 1 and no greater than 1000. By default, it is 20.

nextPageToken - The pagination token from the response of a previous request.

$fields - Selector specifying which fields to include in a partial response.

Completes with a GoogleCloudIdentitytoolkitV1DownloadAccountResponse.

Completes with a commons.ApiRequestError if the API endpoint returned an error.

If the used http.Client completes with an error when making a REST call, this method will complete with the same error.

Implementation

async.Future<GoogleCloudIdentitytoolkitV1DownloadAccountResponse> batchGet(
  core.String targetProjectId,
  core.String tenantId, {
  core.String? delegatedProjectNumber,
  core.int? maxResults,
  core.String? nextPageToken,
  core.String? $fields,
}) async {
  final queryParams_ = <core.String, core.List<core.String>>{
    if (delegatedProjectNumber != null)
      'delegatedProjectNumber': [delegatedProjectNumber],
    if (maxResults != null) 'maxResults': ['${maxResults}'],
    if (nextPageToken != null) 'nextPageToken': [nextPageToken],
    if ($fields != null) 'fields': [$fields],
  };

  final url_ = 'v1/projects/' +
      core.Uri.encodeFull('$targetProjectId') +
      '/tenants/' +
      core.Uri.encodeFull('$tenantId') +
      '/accounts:batchGet';

  final response_ = await _requester.request(
    url_,
    'GET',
    queryParams: queryParams_,
  );
  return GoogleCloudIdentitytoolkitV1DownloadAccountResponse.fromJson(
      response_ as core.Map<core.String, core.dynamic>);
}