Skip to main content

A Python library for managing Google Cloud Platform groups via Google Workspace Directory API

Project description

Google-Group-Admin-API

A Python library for managing Google Cloud Platform (GCP) groups through the Google Workspace Directory API. This tool allows easy and efficient group management within Google Workspace, including adding members to groups, retrieving group information, listing all groups in a domain, and creating new groups.

Features

  • Add Members to Groups: Easily add users to specific Google Workspace groups with designated roles.
  • Get Group Information: Retrieve detailed information about specific groups.
  • List Groups: List all groups within a specified Google Workspace domain.
  • Create Groups: Facilitate the creation of new groups within the Google Workspace.

Prerequisites

  • Python 3.6 or higher
  • Google Workspace domain with admin access
  • Google Cloud Platform project with the Admin SDK API enabled
  • Service account with domain-wide delegation and the necessary permissions

Installation

Clone the repository to your local machine:

git clone https://github.com/martialo12/Google-Group-Admin-API
cd Google-Group-Admin-API

Install the require dependencies

pip install -r requirements.txt

Usage

First, set up your Google Workspace configuration:

from google_workspace_group_manager import GoogleWorkspaceConfig, GoogleWorkspaceGroupManager

scopes = ['https://www.googleapis.com/auth/admin.directory.group']
config = GoogleWorkspaceConfig('path_to_service_account.json', scopes)
group_manager = GoogleWorkspaceGroupManager(config)

Examples

Adding a member to a group:

group_manager.add_member_to_group('group@example.com', 'member@example.com', 'MEMBER')

Retrieving information about a group:

group_info = group_manager.get_group_info('group@example.com')

Listing all groups in a domain:

groups = group_manager.list_google_workspace_groups('example.com')

Creating a new group:

new_group = group_manager.create_group('newgroup@example.com', 'New Group', 'Description')

Contributing

Contributions are welcome! Please read our Contributing Guide for more information.

## License This project is licensed under the MIT License - see the LICENSE file for details.

Acknowledgements

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

Google-Group-Admin-API-1.0.0.tar.gz (4.9 kB view details)

Uploaded Source

Built Distribution

Google_Group_Admin_API-1.0.0-py3-none-any.whl (6.4 kB view details)

Uploaded Python 3

File details

Details for the file Google-Group-Admin-API-1.0.0.tar.gz.

File metadata

  • Download URL: Google-Group-Admin-API-1.0.0.tar.gz
  • Upload date:
  • Size: 4.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.10.13

File hashes

Hashes for Google-Group-Admin-API-1.0.0.tar.gz
Algorithm Hash digest
SHA256 e33efa2c18bbdf9da169898557c2978e85b4db120e0d2bd4fb828b515d64200d
MD5 ff215861cb0e44fc7d8a58b193c6c340
BLAKE2b-256 a7416dcb424652abe477980ba7a2db71f5af98a504e2118a0fb16ae8def11db8

See more details on using hashes here.

File details

Details for the file Google_Group_Admin_API-1.0.0-py3-none-any.whl.

File metadata

File hashes

Hashes for Google_Group_Admin_API-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 992d036ff879dc9a59c47db7b375c503a87c7ed3ddbac5f2bbf6c78c4eafa4b5
MD5 e45490cfe8b81eeba690383d3aef64d6
BLAKE2b-256 a43580aea4692a822b4cb9e55a0df8fe0f62faf371ab11c84ee01d49bb0492ca

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page