GoogleApi.Admin.Directory_v1.Api.Users.directory_users_list

You're seeing just the function directory_users_list, go back to GoogleApi.Admin.Directory_v1.Api.Users module for more information.
Link to this function

directory_users_list(connection, optional_params \\ [], opts \\ [])

View Source

Specs

directory_users_list(Tesla.Env.client(), keyword(), keyword()) ::
  {:ok, GoogleApi.Admin.Directory_v1.Model.Users.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Retrieves a paginated list of either deleted users or all users in a domain.

Parameters

  • connection (type: GoogleApi.Admin.Directory_v1.Connection.t) - Connection to server
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :customFieldMask (type: String.t) - A comma-separated list of schema names. All fields from these schemas are fetched. This should only be set when projection=custom.
    • :customer (type: String.t) - The unique ID for the customer's Google Workspace account. In case of a multi-domain account, to fetch all groups for a customer, fill this field instead of domain. You can also use the my_customer alias to represent your account's customerId. The customerId is also returned as part of the Users resource. Either the customer or the domain parameter must be provided.
    • :domain (type: String.t) - The domain name. Use this field to get fields from only one domain. To return all domains for a customer account, use the customer query parameter instead. Either the customer or the domain parameter must be provided.
    • :event (type: String.t) - Event on which subscription is intended (if subscribing)
    • :maxResults (type: integer()) - Maximum number of results to return.
    • :orderBy (type: String.t) - Property to use for sorting results.
    • :pageToken (type: String.t) - Token to specify next page in the list
    • :projection (type: String.t) - What subset of fields to fetch for this user.
    • :query (type: String.t) - Query string for searching user fields. For more information on constructing user queries, see Search for Users.
    • :showDeleted (type: String.t) - If set to true, retrieves the list of deleted users. (Default: false)
    • :sortOrder (type: String.t) - Whether to return results in ascending or descending order.
    • :viewType (type: String.t) - Whether to fetch the administrator-only or domain-wide public view of the user. For more information, see Retrieve a user as a non-administrator.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Admin.Directory_v1.Model.Users{}} on success
  • {:error, info} on failure