Cloud Search API . debug . identitysources . unmappedids

Instance Methods

close()

Close httplib2 connections.

list(parent, debugOptions_enableDebugging=None, pageSize=None, pageToken=None, resolutionStatusCode=None, x__xgafv=None)

Lists unmapped user identities for an identity source. **Note:** This API requires an admin account to execute.

list_next()

Retrieves the next page of results.

Method Details

close()
Close httplib2 connections.
list(parent, debugOptions_enableDebugging=None, pageSize=None, pageToken=None, resolutionStatusCode=None, x__xgafv=None)
Lists unmapped user identities for an identity source. **Note:** This API requires an admin account to execute.

Args:
  parent: string, The name of the identity source, in the following format: identitysources/{source_id} (required)
  debugOptions_enableDebugging: boolean, If you are asked by Google to help with debugging, set this field. Otherwise, ignore this field.
  pageSize: integer, Maximum number of items to fetch in a request. Defaults to 100.
  pageToken: string, The next_page_token value returned from a previous List request, if any.
  resolutionStatusCode: string, Limit users selection to this status.
    Allowed values
      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.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    {
  "nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no more results in the list.
  "unmappedIdentities": [
    {
      "externalIdentity": { # Reference to a user, group, or domain. # The resource name for an external user.
        "groupResourceName": "A String", # This principal is a group identified using an external identity. The name field must specify the group resource name with this format: identitysources/{source_id}/groups/{ID}
        "gsuitePrincipal": { # This principal is a Google Workspace user, group or domain.
          "gsuiteDomain": True or False, # This principal represents all users of the Google Workspace domain of the customer.
          "gsuiteGroupEmail": "A String", # This principal references a Google Workspace group name.
          "gsuiteUserEmail": "A String", # This principal references a Google Workspace user account.
        },
        "userResourceName": "A String", # This principal is a user identified using an external identity. The name field must specify the user resource name with this format: identitysources/{source_id}/users/{ID}
      },
      "resolutionStatusCode": "A String", # The resolution status for the external identity.
    },
  ],
}
list_next()
Retrieves the next page of results.

        Args:
          previous_request: The request for the previous page. (required)
          previous_response: The response from the request for the previous page. (required)

        Returns:
          A request object that you can call 'execute()' on to request the next
          page. Returns None if there are no more items in the collection.