google.cloud.forseti.common.gcp_api.groups_settings module

Wrapper for Groups Settings API client.

class GroupsSettingsClient(global_configs, **kwargs)[source]

Bases: object

GSuite Groups Settings API Client.

get_groups_settings(group_email)[source]

Get the group settings for a given group.

https://developers.google.com/admin-sdk/groups-settings/v1/reference/groups/get

Parameters:

group_email (str) – The gsuite group email to scope the request to.

Returns:

group settings for given group_email.

Return type:

dict

Raises:
  • api_errors.ApiExecutionError – If groups retrieval fails.
  • RefreshError – If the authentication fails.
class GroupsSettingsRepositoryClient(credentials, quota_max_calls=None, quota_period=1.0, use_rate_limiter=True)[source]

Bases: google.cloud.forseti.common.gcp_api._base_repository.BaseRepositoryClient

Groups Settings API Respository Client.

groups

Returns a _GroupsSettingsGroupsRepository instance.

class _GroupsSettingsGroupsRepository(**kwargs)[source]

Bases: google.cloud.forseti.common.gcp_api.repository_mixins.GetQueryMixin, google.cloud.forseti.common.gcp_api._base_repository.GCPRepository

Implementation of Groups Settings repository.