Forem: Osinachi

Implement Admin SDK Directory API for Google Workspace Management

Osinachi — Thu, 13 Feb 2025 13:06:11 +0000

Intro

This article demonstrates how to programmatically manage Google Workspace administration using Google Workspace Directory API

The Admin SDK Directory API allows enterprise domain administrators to view and manage their organization's users, groups, devices, and resources.

Prerequisites

To Develop on Google Workspace particularly using the Admin SDK API the following has to be set up:

A Google Cloud Project Account
Enable the Admin SDK API
An IAM Service account is created, and the JSON key downloaded
Google Workspace Super Admin Login
Python 3 Installed

Implementation Steps

Step 1

Create a GCP Cloud Project and Enable the Admin SDK API Reference Article

Step 2

Create a service account from your Google Cloud console, IAM, and download the key. Reference article

Step 3

From your Google Workspace admin console → Security → Access and data control → API controls → Manage Domain-Wide Delegation → Add new.

Add Client ID from the Service Account Key you downloaded earlier
Add required OAuth Scopes, for user and group creation the following scopes are required:
- https://www.googleapis.com/auth/admin.directory.user
- https://www.googleapis.com/auth/admin.directory.group
Click Authorize

Step 4

Run the following command to install Google API Client Library.
pip install google-auth google-auth-oauthlib google-auth-httplib2 google-api-python-client

Step 5

Create a Python script to manage users. The sample script below creates a new user in Google Workspace.

from googleapiclient.discovery import build
from google.oauth2 import service_account

# Load the service account credentials
SERVICE_ACCOUNT_FILE = "./path/to/your/service/account/key.json"
SCOPES = ["https://www.googleapis.com/auth/admin.directory.user"]

# Authenticate and build the API client
credentials = service_account.Credentials.from_service_account_file(
    SERVICE_ACCOUNT_FILE, scopes=SCOPES)

# Set up admin API client
admin_email = "super-admin-email@example.com"
delegated_credentials = credentials.with_subject(admin_email)
service = build("admin", "directory_v1", credentials=delegated_credentials)

user_info = {
    "name": {
        "givenName": "Test",
        "familyName": "Doe"
    },
    "password": "SecurePass123!",
    "primaryEmail": "testdoe@example.com"
}

# Create the user
service.users().insert(body=user_info).execute()
print("User Created Successfully!")

Step 6

Save and run the above script using the command below

python file_name.py

If everything is set up correctly, the user will be created successfully on the workspace admin console.

I hope you've found this article useful.

How to set up Jenkins on an EC2 Instance using BashScript

Osinachi — Thu, 25 May 2023 18:55:30 +0000

Introduction

Jenkins is the leading open source development and operations automation server, it provides hundreds of plugins to support building, deploying and automating any project. As a DevOps Engineer, Jenkins has become a necessary tool for Continuous Integration and Deployment, CI/CD.
There are different ways to install and configure a Jenkins server, in this article, I will demonstrate how to get a Jenkins server up and running on an Amazon EC2 Instance using a simple bash script.

Requirements

Basic understanding of Bash scripting
AWS Account with access to the Console and a basic knowledge of how to launch an EC2 instance

Lets get started! 🚀

1. Go to the EC2 dashboard on AWS Console and launch an instance.

Give your instance a name eg. jenkins-server
Select an ubuntu server
Create or select an existing keypair
Create a security group for your instance allowing ssh access on Port 22 and also TCP access on Port 8080 which is the port Jenkins listens on
Scroll down to Advanced details and add the script below to the user data field
Launch Instance
It will take a while before you get the 2/2 checks passed because of the installations.

#!/bin/bash

# install Java

apt update -y
apt install openjdk-11-jdk -y
apt update -y

# Import the GPG key

curl -fsSL https://pkg.jenkins.io/debian-stable/jenkins.io-2023.key | sudo tee \
  /usr/share/keyrings/jenkins-keyring.asc > /dev/null

# Add the Jenkins software repository to the source list and provide the authentication key

echo deb [signed-by=/usr/share/keyrings/jenkins-keyring.asc] \
  https://pkg.jenkins.io/debian-stable binary/ | sudo tee \
  /etc/apt/sources.list.d/jenkins.list > /dev/null

# install jenkins
apt update -y
apt install jenkins -y
systemctl enable jenkins

2. Check if Jenkins was installed successfully.
There are two ways you can confirm that Jenkins was successfully installed.

A. Connect to the server via ssh and run a status check

From AWS Console, choose to connect to the server via ssh

Open any command line tool, change into the directory where the instance's keypair is located. My keypair is called jen.pem located in my download folder.
Change the file permission by running chmod 400 jen.pem
Connect to the server via ssh by running the next code, replace the .pem file name and the server IP. ssh -i "jen.pem" ubuntu@ec2-34-201-67-199.compute-1.amazonaws.com

When you've successfully connected, run the following command: sudo systemctl status jenkins and you should get a Jenkins active status.

B. Open the server IP on a web browser

Copy the public IP address of the server and paste on a browser and add Jenkins Port 8080. 34.201.67.199:8080 then launch and you should connect to a Jenkins page.

Your Jenkins server is ready for use! 🚀

Things to Note

Scripts entered as user data are run as the root user, so do not use the sudo command in the script.
Also, because the script is not run interactively, you cannot include commands that require user feedback (such as apt update without the -y flag).

References

How to Setup Ubuntu 20.04 LTS on your local windows machine using Vagrant

Osinachi — Thu, 04 May 2023 10:14:32 +0000

You have a windows computer, however you need to run some resources on a Linux operating system (OS) while still maintaining your windows machine, this is where system virtualization comes in. In this article, we will loo at how to set up Ubuntu (one of the many Linux OS distributions) on a local windows system without interrupting anything.

Requirements

A host machine (your physical hardware also called bare metal) which is your Laptop or desktop running on a windows operating system with at least an 8GB RAM size.

Outline:

Install VirtualBox
Install Vagrant
Setup Vagrant Box

Let's get started.

A. Download and Install VirtualBox

A virtualization software is required, this is where the Linux OS will be installed. There are a few virtualization software. Most cloud service providers make use of virtualization software to spin up the virtual machines we purchase to host resources on. For this purpose, I will be using VirtualBox (VBox).

Go to Virtual Box to download VirtualBox for windows hosts and complete the installation following the guided GUI.

On completion, a VBox shortcut icon will be created on your desktop by default except you choose not to.

B. Create a new Ubuntu machine from the installed virtual box.

1. New Linux machine named 'AltSchool' (name yours as you wish) with version Ubuntu 64-bit.

2. Allocate memory, here I allocated 4GB memory

3. Create a virtual hard disk with 12GB recommended size

4. My hard disk file type is VirtualBox Disk Image

5. Dynamic storage allocated on physical hard disk

6. My AltSchool Virtual Machine created! 💃

C. SETUP UBUNTU 20.04 LTS ON YOUR LOCAL MACHINE USING VAGRANT

1. Vagrant is an open-source software developed by Hashicorp. It enables the creation and configuration of lightweight, reproducible, and portable development environments. It is designed for anyone to have access to a simple and fast way to create a virtualized environment.

Download Vagrant from Vagrant Up and install it following the default installation prompt.

2. Find a virtual machine image from Vagrant called boxes in this case an Ubuntu 20.04 LTS (Focal64) and take note of the name. There are other Ubuntu images available. You can select any you find suitable.

3. Create a folder where you want your Ubuntu image initialized.
Switch to a terminal (I used PowerShell in this case) and change into the directory. Then to initialize ubuntu, run the following command.

vagrant init ubuntu/focal64

This action creates a Vagrantfile in the current folder, you can run ls to confirm.

Note: If you chose an image different from Ubuntu 20.04 LTS, kindly change focal64 to the exact name of your preferred Vagrant box name

4 Run the next command which looks for the necessary configuration files for creating the virtual machine or downloads it if not found.

vagrant up

5 Then next command lets us access or log in to the ubuntu machine. When complete, your machine will be ready for use.

vagrant ssh

Thanks for reading my article, feel free to drop a comment to share your experience with this method. 😊