google_api_cloud_identity v0.19.1

GoogleApi.CloudIdentity.V1.Api.Groups (google_api_cloud_identity v0.19.1) View Source

API calls for all endpoints tagged Groups.

Link to this section Summary

Functions

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

Creates a Group.

cloudidentity_groups_delete(connection, name, optional_params \\ [], opts \\ [])

Deletes a Group.

cloudidentity_groups_get(connection, name, optional_params \\ [], opts \\ [])

Retrieves a Group.

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

Lists the Groups under a customer or namespace.

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

Looks up the resource name of a Group by its EntityKey.

cloudidentity_groups_memberships_create(connection, parent, optional_params \\ [], opts \\ [])

Creates a Membership.

cloudidentity_groups_memberships_delete(connection, name, optional_params \\ [], opts \\ [])

Deletes a Membership.

cloudidentity_groups_memberships_get(connection, name, optional_params \\ [], opts \\ [])

Retrieves a Membership.

cloudidentity_groups_memberships_list(connection, parent, optional_params \\ [], opts \\ [])

Lists the Memberships within a Group.

cloudidentity_groups_memberships_lookup(connection, parent, optional_params \\ [], opts \\ [])

Looks up the resource name of a Membership by its EntityKey.

cloudidentity_groups_memberships_modify_membership_roles(connection, name, optional_params \\ [], opts \\ [])

Modifies the MembershipRoles of a Membership.

cloudidentity_groups_patch(connection, name, optional_params \\ [], opts \\ [])

Updates a Group.

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

Searches for Groups matching a specified query.

Link to this section Functions

Link to this function

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

View Source

Specs

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

Creates a Group.

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").
    • :initialGroupConfig (type: String.t) - Optional. The initial configuration option for the Group.
    • :body (type: GoogleApi.CloudIdentity.V1.Model.Group.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.CloudIdentity.V1.Model.Operation{}} on success
  • {:error, info} on failure
Link to this function

cloudidentity_groups_delete(connection, name, optional_params \\ [], opts \\ [])

View Source

Specs

cloudidentity_groups_delete(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.CloudIdentity.V1.Model.Operation.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, any()}

Deletes a Group.

Parameters

  • connection (type: GoogleApi.CloudIdentity.V1.Connection.t) - Connection to server
  • name (type: String.t) - Required. The resource name of the Group to retrieve. Must be of the form groups/{group_id}.
  • 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").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.CloudIdentity.V1.Model.Operation{}} on success
  • {:error, info} on failure
Link to this function

cloudidentity_groups_get(connection, name, optional_params \\ [], opts \\ [])

View Source

Specs

cloudidentity_groups_get(Tesla.Env.client(), String.t(), keyword(), keyword()) ::
  {:ok, GoogleApi.CloudIdentity.V1.Model.Group.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, any()}

Retrieves a Group.

Parameters

  • connection (type: GoogleApi.CloudIdentity.V1.Connection.t) - Connection to server
  • name (type: String.t) - Required. The resource name of the Group to retrieve. Must be of the form groups/{group_id}.
  • 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").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.CloudIdentity.V1.Model.Group{}} on success
  • {:error, info} on failure
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()}
  | {:error, any()}

Lists the Groups 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 Groups. Must be of the form identitysources/{identity_source_id} for external- identity-mapped groups or customers/{customer_id} for Google Groups.
    • :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
Link to this function

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

View Source

Specs

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

Looks up the resource name of a Group by its EntityKey.

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").
    • :"groupKey.id" (type: String.t) - The ID of the entity. For Google-managed entities, the id should be the email address of an existing group or user. For external-identity-mapped entities, the id must be a string conforming to the Identity Source's requirements. Must be unique within a namespace.
    • :"groupKey.namespace" (type: String.t) - The namespace in which the entity exists. If not specified, the EntityKey represents a Google-managed entity such as a Google user or a Google Group. If specified, the EntityKey represents an external-identity-mapped group. The namespace must correspond to an identity source created in Admin Console and must be in the form of `identitysources/{identity_source_id}.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.CloudIdentity.V1.Model.LookupGroupNameResponse{}} on success
  • {:error, info} on failure
Link to this function

cloudidentity_groups_memberships_create(connection, parent, optional_params \\ [], opts \\ [])

View Source

Specs

cloudidentity_groups_memberships_create(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.CloudIdentity.V1.Model.Operation.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, any()}

Creates a Membership.

Parameters

  • connection (type: GoogleApi.CloudIdentity.V1.Connection.t) - Connection to server
  • parent (type: String.t) - Required. The parent Group resource under which to create the Membership. Must be of the form groups/{group_id}.
  • 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").
    • :body (type: GoogleApi.CloudIdentity.V1.Model.Membership.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.CloudIdentity.V1.Model.Operation{}} on success
  • {:error, info} on failure
Link to this function

cloudidentity_groups_memberships_delete(connection, name, optional_params \\ [], opts \\ [])

View Source

Specs

cloudidentity_groups_memberships_delete(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.CloudIdentity.V1.Model.Operation.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, any()}

Deletes a Membership.

Parameters

  • connection (type: GoogleApi.CloudIdentity.V1.Connection.t) - Connection to server
  • name (type: String.t) - Required. The resource name of the Membership to delete. Must be of the form groups/{group_id}/memberships/{membership_id}
  • 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").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.CloudIdentity.V1.Model.Operation{}} on success
  • {:error, info} on failure
Link to this function

cloudidentity_groups_memberships_get(connection, name, optional_params \\ [], opts \\ [])

View Source

Specs

cloudidentity_groups_memberships_get(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.CloudIdentity.V1.Model.Membership.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, any()}

Retrieves a Membership.

Parameters

  • connection (type: GoogleApi.CloudIdentity.V1.Connection.t) - Connection to server
  • name (type: String.t) - Required. The resource name of the Membership to retrieve. Must be of the form groups/{group_id}/memberships/{membership_id}.
  • 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").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.CloudIdentity.V1.Model.Membership{}} on success
  • {:error, info} on failure
Link to this function

cloudidentity_groups_memberships_list(connection, parent, optional_params \\ [], opts \\ [])

View Source

Specs

cloudidentity_groups_memberships_list(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.CloudIdentity.V1.Model.ListMembershipsResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, any()}

Lists the Memberships within a Group.

Parameters

  • connection (type: GoogleApi.CloudIdentity.V1.Connection.t) - Connection to server
  • parent (type: String.t) - Required. The parent Group resource under which to lookup the Membership name. Must be of the form groups/{group_id}.
  • 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 GroupView.BASIC and to 50 for GroupView.FULL. Must not be greater than 1000 for GroupView.BASIC or 500 for GroupView.FULL.
    • :pageToken (type: String.t) - The next_page_token value returned from a previous search request, if any.
    • :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.ListMembershipsResponse{}} on success
  • {:error, info} on failure
Link to this function

cloudidentity_groups_memberships_lookup(connection, parent, optional_params \\ [], opts \\ [])

View Source

Specs

cloudidentity_groups_memberships_lookup(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.CloudIdentity.V1.Model.LookupMembershipNameResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, any()}

Looks up the resource name of a Membership by its EntityKey.

Parameters

  • connection (type: GoogleApi.CloudIdentity.V1.Connection.t) - Connection to server
  • parent (type: String.t) - Required. The parent Group resource under which to lookup the Membership name. Must be of the form groups/{group_id}.
  • 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").
    • :"memberKey.id" (type: String.t) - The ID of the entity. For Google-managed entities, the id should be the email address of an existing group or user. For external-identity-mapped entities, the id must be a string conforming to the Identity Source's requirements. Must be unique within a namespace.
    • :"memberKey.namespace" (type: String.t) - The namespace in which the entity exists. If not specified, the EntityKey represents a Google-managed entity such as a Google user or a Google Group. If specified, the EntityKey represents an external-identity-mapped group. The namespace must correspond to an identity source created in Admin Console and must be in the form of `identitysources/{identity_source_id}.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.CloudIdentity.V1.Model.LookupMembershipNameResponse{}} on success
  • {:error, info} on failure
Link to this function

cloudidentity_groups_memberships_modify_membership_roles(connection, name, optional_params \\ [], opts \\ [])

View Source

Specs

cloudidentity_groups_memberships_modify_membership_roles(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.CloudIdentity.V1.Model.ModifyMembershipRolesResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, any()}

Modifies the MembershipRoles of a Membership.

Parameters

  • connection (type: GoogleApi.CloudIdentity.V1.Connection.t) - Connection to server
  • name (type: String.t) - Required. The resource name of the Membership whose roles are to be modified. Must be of the form groups/{group_id}/memberships/{membership_id}.
  • 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").
    • :body (type: GoogleApi.CloudIdentity.V1.Model.ModifyMembershipRolesRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.CloudIdentity.V1.Model.ModifyMembershipRolesResponse{}} on success
  • {:error, info} on failure
Link to this function

cloudidentity_groups_patch(connection, name, optional_params \\ [], opts \\ [])

View Source

Specs

cloudidentity_groups_patch(Tesla.Env.client(), String.t(), keyword(), keyword()) ::
  {:ok, GoogleApi.CloudIdentity.V1.Model.Operation.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, any()}

Updates a Group.

Parameters

  • connection (type: GoogleApi.CloudIdentity.V1.Connection.t) - Connection to server
  • name (type: String.t) - Output only. The resource name of the Group. Shall be of the form groups/{group_id}.
  • 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").
    • :updateMask (type: String.t) - Required. The fully-qualified names of fields to update. May only contain the following fields: display_name, description.
    • :body (type: GoogleApi.CloudIdentity.V1.Model.Group.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.CloudIdentity.V1.Model.Operation{}} on success
  • {:error, info} on failure
Link to this function

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

View Source

Specs

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

Searches for Groups matching a specified query.

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 GroupView.BASIC and 50 for GroupView.FULL. Must not be greater than 1000 for GroupView.BASIC or 500 for GroupView.FULL.
    • :pageToken (type: String.t) - The next_page_token value returned from a previous search request, if any.
    • :query (type: String.t) - Required. The search query. Must be specified in Common Expression Language. May only contain equality operators on the parent and inclusion operators on labels (e.g., parent == 'customers/{customer_id}' && 'cloudidentity.googleapis.com/groups.discussion_forum' in labels).
    • :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.SearchGroupsResponse{}} on success
  • {:error, info} on failure