google_api_admin v0.11.0 GoogleApi.Admin.Directory_v1.Api.Members View Source
API calls for all endpoints tagged Members
.
Link to this section Summary
Functions
Remove membership.
Retrieve Group Member
Checks whether the given user is a member of the group. Membership can be direct or nested.
Add user to the specified group.
Retrieve all members in a group (paginated)
Update membership of a user in the specified group. This method supports patch semantics.
Update membership of a user in the specified group.
Link to this section Functions
directory_members_delete(connection, group_key, member_key, optional_params \\ [], opts \\ [])
View Sourcedirectory_members_delete( Tesla.Env.client(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, nil} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Remove membership.
Parameters
connection
(type:GoogleApi.Admin.Directory_v1.Connection.t
) - Connection to servergroup_key
(type:String.t
) - Email or immutable ID of the groupmember_key
(type:String.t
) - Email or immutable ID of the memberoptional_params
(type:keyword()
) - Optional parameters:alt
(type:String.t
) - Data format for the response.: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
) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.:userIp
(type:String.t
) - Deprecated. Please use quotaUser instead.
opts
(type:keyword()
) - Call options
Returns
{:ok, %{}}
on success{:error, info}
on failure
directory_members_get(connection, group_key, member_key, optional_params \\ [], opts \\ [])
View Sourcedirectory_members_get( Tesla.Env.client(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Admin.Directory_v1.Model.Member.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Retrieve Group Member
Parameters
connection
(type:GoogleApi.Admin.Directory_v1.Connection.t
) - Connection to servergroup_key
(type:String.t
) - Email or immutable ID of the groupmember_key
(type:String.t
) - Email or immutable ID of the memberoptional_params
(type:keyword()
) - Optional parameters:alt
(type:String.t
) - Data format for the response.: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
) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.:userIp
(type:String.t
) - Deprecated. Please use quotaUser instead.
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 \\ [])
View Sourcedirectory_members_has_member( Tesla.Env.client(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Admin.Directory_v1.Model.MembersHasMember.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Checks whether the given user is a member of the group. Membership can be direct or nested.
Parameters
connection
(type:GoogleApi.Admin.Directory_v1.Connection.t
) - Connection to servergroup_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:alt
(type:String.t
) - Data format for the response.: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
) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.:userIp
(type:String.t
) - Deprecated. Please use quotaUser instead.
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 \\ [])
View Sourcedirectory_members_insert(Tesla.Env.client(), String.t(), keyword(), keyword()) :: {:ok, GoogleApi.Admin.Directory_v1.Model.Member.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Add user to the specified group.
Parameters
connection
(type:GoogleApi.Admin.Directory_v1.Connection.t
) - Connection to servergroup_key
(type:String.t
) - Email or immutable ID of the groupoptional_params
(type:keyword()
) - Optional parameters:alt
(type:String.t
) - Data format for the response.: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
) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.:userIp
(type:String.t
) - Deprecated. Please use quotaUser instead.: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 \\ [])
View Sourcedirectory_members_list(Tesla.Env.client(), String.t(), keyword(), keyword()) :: {:ok, GoogleApi.Admin.Directory_v1.Model.Members.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Retrieve all members in a group (paginated)
Parameters
connection
(type:GoogleApi.Admin.Directory_v1.Connection.t
) - Connection to servergroup_key
(type:String.t
) - Email or immutable ID of the groupoptional_params
(type:keyword()
) - Optional parameters:alt
(type:String.t
) - Data format for the response.: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
) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.:userIp
(type:String.t
) - Deprecated. Please use quotaUser instead.: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
) - Comma separated role values to filter list results on.
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 \\ [])
View Sourcedirectory_members_patch( Tesla.Env.client(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Admin.Directory_v1.Model.Member.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Update membership of a user in the specified group. This method supports patch semantics.
Parameters
connection
(type:GoogleApi.Admin.Directory_v1.Connection.t
) - Connection to servergroup_key
(type:String.t
) - Email or immutable ID of the group. If ID, it should match with id of group objectmember_key
(type:String.t
) - Email or immutable ID of the user. If ID, it should match with id of member objectoptional_params
(type:keyword()
) - Optional parameters:alt
(type:String.t
) - Data format for the response.: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
) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.:userIp
(type:String.t
) - Deprecated. Please use quotaUser instead.: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 \\ [])
View Sourcedirectory_members_update( Tesla.Env.client(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Admin.Directory_v1.Model.Member.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Update membership of a user in the specified group.
Parameters
connection
(type:GoogleApi.Admin.Directory_v1.Connection.t
) - Connection to servergroup_key
(type:String.t
) - Email or immutable ID of the group. If ID, it should match with id of group objectmember_key
(type:String.t
) - Email or immutable ID of the user. If ID, it should match with id of member objectoptional_params
(type:keyword()
) - Optional parameters:alt
(type:String.t
) - Data format for the response.: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
) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.:userIp
(type:String.t
) - Deprecated. Please use quotaUser instead.: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