Skip to content

Latest commit

 

History

History
63 lines (36 loc) · 2.75 KB

readme.md

File metadata and controls

63 lines (36 loc) · 2.75 KB

SaaS Admin Service API

The SaaS Admin Service is an API that is reponsible for tenant management operations.

This project hosts a service API which serves as a gateway to administrate the SaaS ecosystem of Tenants.

Overview

Within this folder you will find two subfolders:

  • Saas.Permissions.Service - the C# project for the API
  • deployment - a set of tools for deploying the API for production
    • The sub-subfolder act is for deploying the API for remote debugging
  • Saas.Admin.Service.Tests - Unit tests for the API.

Dependencies

The service depends on:

For a complete overview, please see the SaaS.Admin.Service page in our documentation site.

Provisioning the API

To work with the SaaS Admin Services API it must first be provisions to your Azure ASDK resource group. This is true even if you initially is planning to run the API in your local development environment. The provisioning ensure that configuration and settings to be correctly added to your Azure App Configuration store and readies the API for later deployment to Azure.

Provisioning is easy:

  1. Navigate to the sub folder deployment.

  2. Run these commands:

    ./setup.sh
    ./run.sh

Now you're ready to move on.

How to Run Locally

Guidelines for getting up and running with SaaS Signup Administration in your local development, are identical to the guidelines found the Requirements and the Configuration, settings and secrets when running locally section in the SaaS Permissions Service readme.

Running the SaaS Administration Service API Locally

--- TODO BEGIN ---

Add some guidelines about how to create valid JWT tokens to test the API locally etc...

---TODO END ---

How to Deploy the SaaS Administration Service API to Azure

The guidelines are identity to How to Deploy SaaS Permissions Service API to Azure.

Debugging Remotely in Azure

The guidelines are identity to Debugging in Azure for the SaaS Permissions Service API.

Happy debugging!