View Source GoogleApi.Admin.Directory_v1.Api.Members (google_api_admin v0.40.0)

API calls for all endpoints tagged Members.

Summary

Functions

directory_members_delete(connection, group_key, member_key, optional_params \\ [], opts \\ [])

Removes a member from a group.

directory_members_get(connection, group_key, member_key, optional_params \\ [], opts \\ [])

Retrieves a group member's properties.

directory_members_has_member(connection, group_key, member_key, optional_params \\ [], opts \\ [])

Checks whether the given user is a member of the group. Membership can be direct or nested, but if nested, the memberKey and groupKey must be entities in the same domain or an Invalid input error is returned. To check for nested memberships that include entities outside of the group's domain, use the checkTransitiveMembership() method in the Cloud Identity Groups API.

directory_members_insert(connection, group_key, optional_params \\ [], opts \\ [])

Adds a user to the specified group.

directory_members_list(connection, group_key, optional_params \\ [], opts \\ [])

Retrieves a paginated list of all members in a group. This method times out after 60 minutes. For more information, see Troubleshoot error codes.

directory_members_patch(connection, group_key, member_key, optional_params \\ [], opts \\ [])

Updates the membership properties of a user in the specified group. This method supports patch semantics.

directory_members_update(connection, group_key, member_key, optional_params \\ [], opts \\ [])

Updates the membership of a user in the specified group.

Functions

directory_members_delete(connection, group_key, member_key, optional_params \\ [], opts \\ [])

@spec directory_members_delete(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, nil} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}

Removes a member from a group.

Parameters

connection (type: GoogleApi.Admin.Directory_v1.Connection.t) - Connection to server
group_key (type: String.t) - Identifies the group in the API request. The value can be the group's email address, group alias, or the unique group ID.
member_key (type: String.t) - Identifies the group member in the API request. A group member can be a user or another group. The value can be the member's (group or user) primary email address, alias, or unique 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, %{}} on success
{:error, info} on failure

directory_members_get(connection, group_key, member_key, optional_params \\ [], opts \\ [])

@spec directory_members_get(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Admin.Directory_v1.Model.Member.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Retrieves a group member's properties.

Parameters

connection (type: GoogleApi.Admin.Directory_v1.Connection.t) - Connection to server
group_key (type: String.t) - Identifies the group in the API request. The value can be the group's email address, group alias, or the unique group ID.
member_key (type: String.t) - Identifies the group member in the API request. A group member can be a user or another group. The value can be the member's (group or user) primary email address, alias, or unique 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.Admin.Directory_v1.Model.Member{}} on success
{:error, info} on failure

directory_members_has_member(connection, group_key, member_key, optional_params \\ [], opts \\ [])

@spec directory_members_has_member(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Admin.Directory_v1.Model.MembersHasMember.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Parameters

connection (type: GoogleApi.Admin.Directory_v1.Connection.t) - Connection to server
group_key (type: String.t) - Identifies the group in the API request. The value can be the group's email address, group alias, or the unique group ID.
member_key (type: String.t) - Identifies the user member in the API request. The value can be the user's primary email address, alias, or unique 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.Admin.Directory_v1.Model.MembersHasMember{}} on success
{:error, info} on failure

directory_members_insert(connection, group_key, optional_params \\ [], opts \\ [])

@spec directory_members_insert(Tesla.Env.client(), String.t(), keyword(), keyword()) ::
  {:ok, GoogleApi.Admin.Directory_v1.Model.Member.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Adds a user to the specified group.

Parameters

connection (type: GoogleApi.Admin.Directory_v1.Connection.t) - Connection to server
group_key (type: String.t) - Identifies the group in the API request. The value can be the group's email address, group alias, or the unique 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.Admin.Directory_v1.Model.Member.t) -
opts (type: keyword()) - Call options

Returns

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

directory_members_list(connection, group_key, optional_params \\ [], opts \\ [])

@spec directory_members_list(Tesla.Env.client(), String.t(), keyword(), keyword()) ::
  {:ok, GoogleApi.Admin.Directory_v1.Model.Members.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Retrieves a paginated list of all members in a group. This method times out after 60 minutes. For more information, see Troubleshoot error codes.

Parameters

connection (type: GoogleApi.Admin.Directory_v1.Connection.t) - Connection to server
group_key (type: String.t) - Identifies the group in the API request. The value can be the group's email address, group alias, or the unique 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").
- :includeDerivedMembership (type: boolean()) - Whether to list indirect memberships. Default: false.
- :maxResults (type: integer()) - Maximum number of results to return. Max allowed value is 200.
- :pageToken (type: String.t) - Token to specify next page in the list.
- :roles (type: String.t) - The roles query parameter allows you to retrieve group members by role. Allowed values are OWNER, MANAGER, and MEMBER.
opts (type: keyword()) - Call options

Returns

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

directory_members_patch(connection, group_key, member_key, optional_params \\ [], opts \\ [])

@spec directory_members_patch(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Admin.Directory_v1.Model.Member.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Updates the membership properties of a user in the specified group. This method supports patch semantics.

Parameters

connection (type: GoogleApi.Admin.Directory_v1.Connection.t) - Connection to server
group_key (type: String.t) - Identifies the group in the API request. The value can be the group's email address, group alias, or the unique group ID.
member_key (type: String.t) - Identifies the group member in the API request. A group member can be a user or another group. The value can be the member's (group or user) primary email address, alias, or unique 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.Admin.Directory_v1.Model.Member.t) -
opts (type: keyword()) - Call options

Returns

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

directory_members_update(connection, group_key, member_key, optional_params \\ [], opts \\ [])

@spec directory_members_update(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Admin.Directory_v1.Model.Member.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Updates the membership of a user in the specified group.

Parameters

connection (type: GoogleApi.Admin.Directory_v1.Connection.t) - Connection to server
group_key (type: String.t) - Identifies the group in the API request. The value can be the group's email address, group alias, or the unique group ID.
member_key (type: String.t) - Identifies the group member in the API request. A group member can be a user or another group. The value can be the member's (group or user) primary email address, alias, or unique 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.Admin.Directory_v1.Model.Member.t) -
opts (type: keyword()) - Call options

Returns

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