GoogleApi.CloudIdentity.V1.Api.Groups.cloudidentity_groups_list

You're seeing just the function cloudidentity_groups_list, go back to GoogleApi.CloudIdentity.V1.Api.Groups module for more information.
Link to this function

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

View Source

Specs

cloudidentity_groups_list(Tesla.Env.client(), keyword(), keyword()) ::
  {:ok, GoogleApi.CloudIdentity.V1.Model.ListGroupsResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Lists the Group resources under a customer or namespace.

Parameters

  • connection (type: GoogleApi.CloudIdentity.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").
    • :pageSize (type: integer()) - The maximum number of results to return. Note that the number of results returned may be less than this value even if there are more available results. To fetch all results, clients must continue calling this method repeatedly until the response no longer contains a next_page_token. If unspecified, defaults to 200 for View.BASIC and to 50 for View.FULL. Must not be greater than 1000 for View.BASIC or 500 for View.FULL.
    • :pageToken (type: String.t) - The next_page_token value returned from a previous list request, if any.
    • :parent (type: String.t) - Required. The parent resource under which to list all Group resources. Must be of the form identitysources/{identity_source_id} for external- identity-mapped groups or customers/{customer_id} for Google Groups. The customer_id must begin with "C" (for example, 'C046psxkn').
    • :view (type: String.t) - The level of detail to be returned. If unspecified, defaults to View.BASIC.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.CloudIdentity.V1.Model.ListGroupsResponse{}} on success
  • {:error, info} on failure