google_api_cloud_identity v0.6.0 GoogleApi.CloudIdentity.V1.Api.Groups View Source

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

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").
- :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

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

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

Deletes a Group.

Parameters

connection (type: GoogleApi.CloudIdentity.V1.Connection.t) - Connection to server
name (type: String.t) - Required. Resource name of the Group in the format: groups/{group_id}, where group_id is the unique ID assigned to the Group.
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

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

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

Retrieves a Group.

Parameters

connection (type: GoogleApi.CloudIdentity.V1.Connection.t) - Connection to server
name (type: String.t) - Required. Resource name of the Group in the format: groups/{group_id}, where group_id is the unique ID assigned to the Group.
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

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

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

Lists groups within a customer or a domain.

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 default page size is 200 (max 1000) for the BASIC view, and 50 (max 500) for the FULL view.
- :pageToken (type: String.t) - The next_page_token value returned from a previous list request, if any.
- :parent (type: String.t) - Required. Customer ID to list all groups from.
- :view (type: String.t) - Group resource view to be returned. Defaults to View.BASIC.
opts (type: keyword()) - Call options

Returns

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

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

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

Looks up 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 within the given namespace. The ID must be unique within its namespace.
- :"groupKey.namespace" (type: String.t) - Namespaces provide isolation for IDs, so an ID only needs to be unique within its namespace.
  
  Namespaces are currently only created as part of IdentitySource creation from Admin Console. A namespace "identitysources/{identity_source_id}" is created corresponding to every Identity Source identity_source_id.
opts (type: keyword()) - Call options

Returns

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

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

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

Creates a Membership.

Parameters

connection (type: GoogleApi.CloudIdentity.V1.Connection.t) - Connection to server
parent (type: String.t) - Required. Resource name of the Group to create Membership within. Format: groups/{group_id}, where group_id is the unique ID assigned to the Group.
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

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

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

Deletes a Membership.

Parameters

connection (type: GoogleApi.CloudIdentity.V1.Connection.t) - Connection to server
name (type: String.t) - Required. Resource name of the Membership to be deleted.

Format: groups/{group_id}/memberships/{member_id}, where group_id is the unique ID assigned to the Group to which Membership belongs to, and member_id is the unique ID assigned to the member.
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

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

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

Retrieves a Membership.

Parameters

connection (type: GoogleApi.CloudIdentity.V1.Connection.t) - Connection to server
name (type: String.t) - Required. Resource name of the Membership to be retrieved.

Format: groups/{group_id}/memberships/{member_id}, where group_id is the unique id assigned to the Group to which Membership belongs to, and member_id is the unique ID assigned to the member.
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

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

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

Lists Memberships within a Group.

Parameters

connection (type: GoogleApi.CloudIdentity.V1.Connection.t) - Connection to server
parent (type: String.t) - Required. Resource name of the Group to list Memberships within.

Format: groups/{group_id}, where group_id is the unique ID assigned to the Group.
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 default page size is 200 (max 1000) for the BASIC view, and 50 (max 500) for the FULL view.
- :pageToken (type: String.t) - The next_page_token value returned from a previous list request, if any.
- :view (type: String.t) - Membership resource view to be returned. Defaults to View.BASIC.
opts (type: keyword()) - Call options

Returns

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

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

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

Looks up resource name of a Membership within a Group by member's EntityKey.

Parameters

connection (type: GoogleApi.CloudIdentity.V1.Connection.t) - Connection to server
parent (type: String.t) - Required. Resource name of the Group to lookup Membership within.

Format: groups/{group_id}, where group_id is the unique ID assigned to the Group.
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 within the given namespace. The ID must be unique within its namespace.
- :"memberKey.namespace" (type: String.t) - Namespaces provide isolation for IDs, so an ID only needs to be unique within its namespace.
  
  Namespaces are currently only created as part of IdentitySource creation from Admin Console. A namespace "identitysources/{identity_source_id}" is created corresponding to every Identity Source identity_source_id.
opts (type: keyword()) - Call options

Returns

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

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

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

Updates a Group.

Parameters

connection (type: GoogleApi.CloudIdentity.V1.Connection.t) - Connection to server
name (type: String.t) - Output only. Resource name of the Group in the format: groups/{group_id}, where group_id is the unique ID assigned to the Group.

Must be left blank while creating a Group.
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. Editable 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

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

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

Searches for Groups.

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 default page size is 200 (max 1000) for the BASIC view, and 50 (max 500) for the FULL view.
- :pageToken (type: String.t) - The next_page_token value returned from a previous search request, if any.
- :query (type: String.t) - Required. Required. Query string for performing search on groups. Users can search on parent and label attributes of groups. EXACT match ('==') is supported on parent, and CONTAINS match ('in') is supported on labels.
- :view (type: String.t) - Group resource view to be returned. Defaults to View.BASIC.
opts (type: keyword()) - Call options

Returns

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