idp-scim-sync

README

idp-scim-sync

Keep your AWS Single Sign-On (SSO) groups and users in sync with your Google Workspace directory using and AWS Lambda function.

As the image above shows, the AWS Lambda function is triggered by a CloudWatch event rule, the event rule is configured to run every 15 minutes (default in the cfn template), and sync the AWS Single Sign-On (SSO) groups and users with Google Workspace directory using their respective APIs. During the first sync, the data of the Groups and Users are stored in the AWS S3 bucket as the State file

The State file is a custom implementation to save time and requests to the AWS SSO SCIM API, also mitigate some limitations of this.

This project is developed using the Go language and AWS SAM, a tool for creating, publishing and deploying AWS Serverless Applications in an easy way.

If you want to know what creates the CloudFormation Template, please check the AWS SAM Template

First time implementing Single Sign-on on AWS? please read Using SSO

The best way to to deploy and use this is through the AWS Serverless public repository - slashdevops/idp-scim-sync

Important

The documentation is a WIP and you can contribute!

Repositories

• AWS Serverless public repository - slashdevops/idp-scim-sync
• AWS ECR public repository - slashdevops/idp-scim-sync
• GitHub public repository - slashdevops/idp-scim-sync
• Docker Hub public repository - slashdevops/idp-scim-sync

Limitations

Most of the limitations of this project are due to AWS SSO SCIM API Limitations.

• Use less than 50 Groups --> AWS SSO SCIM API (ListGroups) has a limit of 50 Groups per request.
• Too much Users and Groups could generate a ThrottlingException of the some AWS SSO SCIM API methods

NOTES:

1. The use of the The State file could mitigate the number 1, but I recommend you be cautious of these limitations as well.
2. The project implements a well-known HTTP Retryable client to mitigate the number 2, but I recommend you be cautious of these limitations as well.

Users that come from the project SSO Sync

• This project only implement the --sync-method groups, so if you are using the --sync-method users_groups you can't use it, because this is going to delete and recreate your data in the AWS SSO side.
• This project only implement the filter for the Google Workspace Groups, so if you are using the filter for the Google Workspace Users, you can't use it. Please see Using SSO for more information.
• The flags names of this project are different from the ones of the SSO Sync
• Not "all the features" of the SSO Sync are not implemented here, and maybe will not.

Components

1. idpscim is a program for keeping AWS Single Sign-On (SSO) groups and users synced with Google Workspace directory service using the AWS SSO SCIM API. Details here.
2. idpscimcli is is a command-line tool to check and validate some functionalities implemented in idpscim. Details here.

Requirements

• AWS Single Sign-On -> Connect to your external identity provider
• AWS Single Sign-On -> Automatic provisioning

How to use

To use this project you have different options, and depending on your needs you can use the following

In AWS

There are two ways to use this project in AWS and described below.

Using AWS Serverless Repository

This is the easy way, this project is deployed as a AWS Serverless Application in AWS Serverless Application Repository.

The public repository of the project is slashdevops/idp-scim-sync

NOTE: The repository depends on your AWS Region.

Using AWS SAM

This is the way if you want to build an deploy the lambda function from your local machine.

Requirements:

1. git
2. Go
3. AWS SAM Cli

Validate, Build and Deploy:

aws cloudformation validate-template --template-body file://template.yaml 1>/dev/null
sam validate

sam deploy --guided

Are you using AWS Cli Profiles?, read AWS-SAM

In Local

You will have two ways to execute the binaries of this project in local, building these or using the pre-built stored in the github repository project.

Building the project

To build the project in local, you will need to have installed and configured at least the following:

1. git
2. Go
3. make

Then you will need to clone the repository in your local machine, and execute the following commands:

• Compile for your Operating System:

make

then the binaries are in build/ folder.

• Cross-compiling the project for Windows, MacOS and Linux (default)

make clean
make test # optional
make build-dist

then the binaries are in dist/ folder.

• Others Operating Systems, see the list of supported platforms in the syslist.go

make clean
GO_OS=<something from goosList in syslist.go> GO_ARCH=<something from goarchList in syslist.go> make test # optional
GO_OS=<something from goosList in syslist.go> GO_ARCH=<something from goarchList in syslist.go> make build-dist

then the binaries are in dist/ folder.

• Execute

./idpscim --help
#or
./idpscimcli --help

Using the pre-built binaries

This is the easy way, just download the binaries you need from the github repository releases

and see Execute the binaries.

Using the pre-built binaries in local

Example docs/Demo.md

License

This module is released under the Apache License Version 2.0:

• http://www.apache.org/licenses/LICENSE-2.0.html