google_api_admin v0.12.0 GoogleApi.Admin.Directory_v1.Api.Groups View Source
API calls for all endpoints tagged Groups
.
Link to this section Summary
Functions
Remove a alias for the group
Add a alias for the group
List all aliases for a group
Retrieve all groups of a domain or of a user given a userKey (paginated)
Update Group. This method supports patch semantics.
Link to this section Functions
directory_groups_aliases_delete(connection, group_key, alias, optional_params \\ [], opts \\ [])
View Sourcedirectory_groups_aliases_delete( Tesla.Env.client(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, nil} | {:ok, Tesla.Env.t()} | {:error, any()}
Remove a alias for the group
Parameters
connection
(type:GoogleApi.Admin.Directory_v1.Connection.t
) - Connection to servergroup_key
(type:String.t
) - Email or immutable ID of the groupalias
(type:String.t
) - The alias to be removedoptional_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_groups_aliases_insert(connection, group_key, optional_params \\ [], opts \\ [])
View Sourcedirectory_groups_aliases_insert( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Admin.Directory_v1.Model.Alias.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
Add a alias for the 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.Alias.t
) -
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Admin.Directory_v1.Model.Alias{}}
on success{:error, info}
on failure
directory_groups_aliases_list(connection, group_key, optional_params \\ [], opts \\ [])
View Sourcedirectory_groups_aliases_list( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Admin.Directory_v1.Model.Aliases.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
List all aliases for a 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.
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Admin.Directory_v1.Model.Aliases{}}
on success{:error, info}
on failure
directory_groups_delete(connection, group_key, optional_params \\ [], opts \\ [])
View Sourcedirectory_groups_delete(Tesla.Env.client(), String.t(), keyword(), keyword()) :: {:ok, nil} | {:ok, Tesla.Env.t()} | {:error, any()}
Delete 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.
opts
(type:keyword()
) - Call options
Returns
{:ok, %{}}
on success{:error, info}
on failure
directory_groups_get(connection, group_key, optional_params \\ [], opts \\ [])
View Sourcedirectory_groups_get(Tesla.Env.client(), String.t(), keyword(), keyword()) :: {:ok, GoogleApi.Admin.Directory_v1.Model.Group.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
Retrieve 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.
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Admin.Directory_v1.Model.Group{}}
on success{:error, info}
on failure
directory_groups_insert(connection, optional_params \\ [], opts \\ [])
View Sourcedirectory_groups_insert(Tesla.Env.client(), keyword(), keyword()) :: {:ok, GoogleApi.Admin.Directory_v1.Model.Group.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
Create Group
Parameters
connection
(type:GoogleApi.Admin.Directory_v1.Connection.t
) - Connection to serveroptional_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.Group.t
) -
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Admin.Directory_v1.Model.Group{}}
on success{:error, info}
on failure
directory_groups_list(connection, optional_params \\ [], opts \\ [])
View Sourcedirectory_groups_list(Tesla.Env.client(), keyword(), keyword()) :: {:ok, GoogleApi.Admin.Directory_v1.Model.Groups.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
Retrieve all groups of a domain or of a user given a userKey (paginated)
Parameters
connection
(type:GoogleApi.Admin.Directory_v1.Connection.t
) - Connection to serveroptional_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.:customer
(type:String.t
) - Immutable ID of the G Suite account. In case of multi-domain, to fetch all groups for a customer, fill this field instead of domain.:domain
(type:String.t
) - Name of the domain. Fill this field to get groups from only this domain. To return all groups in a multi-domain fill customer field instead.:maxResults
(type:integer()
) - Maximum number of results to return. Max allowed value is 200.:orderBy
(type:String.t
) - Column to use for sorting results:pageToken
(type:String.t
) - Token to specify next page in the list:query
(type:String.t
) - Query string search. Should be of the form "". Complete documentation is at https://developers.google.com/admin-sdk/directory/v1/guides/search-groups:sortOrder
(type:String.t
) - Whether to return results in ascending or descending order. Only of use when orderBy is also used:userKey
(type:String.t
) - Email or immutable ID of the user if only those groups are to be listed, the given user is a member of. If it's an ID, it should match with the ID of the user object.
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Admin.Directory_v1.Model.Groups{}}
on success{:error, info}
on failure
directory_groups_patch(connection, group_key, optional_params \\ [], opts \\ [])
View Sourcedirectory_groups_patch(Tesla.Env.client(), String.t(), keyword(), keyword()) :: {:ok, GoogleApi.Admin.Directory_v1.Model.Group.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
Update 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 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.Group.t
) -
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Admin.Directory_v1.Model.Group{}}
on success{:error, info}
on failure
directory_groups_update(connection, group_key, optional_params \\ [], opts \\ [])
View Sourcedirectory_groups_update(Tesla.Env.client(), String.t(), keyword(), keyword()) :: {:ok, GoogleApi.Admin.Directory_v1.Model.Group.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
Update 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 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.Group.t
) -
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Admin.Directory_v1.Model.Group{}}
on success{:error, info}
on failure