list method

Future<ListUnmappedIdentitiesResponse> list(
  1. String parent, {
  2. bool? debugOptions_enableDebugging,
  3. int? pageSize,
  4. String? pageToken,
  5. String? resolutionStatusCode,
  6. String? $fields,
})

Lists unmapped user identities for an identity source.

Note: This API requires an admin account to execute.

Request parameters:

parent - The name of the identity source, in the following format: identitysources/{source_id} Value must have pattern ^identitysources/\[^/\]+$.

debugOptions_enableDebugging - If you are asked by Google to help with debugging, set this field. Otherwise, ignore this field.

pageSize - Maximum number of items to fetch in a request. Defaults to 100.

pageToken - The next_page_token value returned from a previous List request, if any.

resolutionStatusCode - Limit users selection to this status. Possible string values are:

  • "CODE_UNSPECIFIED" : Input-only value. Used to list all unmapped identities regardless of status.
  • "NOT_FOUND" : The unmapped identity was not found in IDaaS, and needs to be provided by the user.
  • "IDENTITY_SOURCE_NOT_FOUND" : The identity source associated with the identity was either not found or deleted.
  • "IDENTITY_SOURCE_MISCONFIGURED" : IDaaS does not understand the identity source, probably because the schema was modified in a non compatible way.
  • "TOO_MANY_MAPPINGS_FOUND" : The number of users associated with the external identity is too large.
  • "INTERNAL_ERROR" : Internal error.

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

Completes with a ListUnmappedIdentitiesResponse.

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<ListUnmappedIdentitiesResponse> list(
  core.String parent, {
  core.bool? debugOptions_enableDebugging,
  core.int? pageSize,
  core.String? pageToken,
  core.String? resolutionStatusCode,
  core.String? $fields,
}) async {
  final queryParams_ = <core.String, core.List<core.String>>{
    if (debugOptions_enableDebugging != null)
      'debugOptions.enableDebugging': ['${debugOptions_enableDebugging}'],
    if (pageSize != null) 'pageSize': ['${pageSize}'],
    if (pageToken != null) 'pageToken': [pageToken],
    if (resolutionStatusCode != null)
      'resolutionStatusCode': [resolutionStatusCode],
    if ($fields != null) 'fields': [$fields],
  };

  final url_ = 'v1/debug/' + core.Uri.encodeFull('$parent') + '/unmappedids';

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