Overview

Universal ID server

The consists of 4 main components:

• The uid-server application Docker image
• A set of YAML configuration files for configuring the application
• A Swagger UI with the API description and executable examples
• Admin UI (beta)

Docker image

The Docker image containing the uid-server application is distributed via Dockerhub and it is available in 2 different platform builds:

• linux/amd64, for production Linux servers
• linux/arm64, for running in a development macOS environment

Configuration

Simple and intuitive configuration. It uses YAML as its configuration language which is robust, easy and logical to write as well as read.

YAML is a superset of JSON, the syntax rules makes it easy to read and edit the configuration files in any editor with syntax highlighting support. The uid-server reads configuration files from the /deployments/config/ directory inside the Docker container. You can add one or more yaml files with your configuration for:

• Application settings such as database connection String, port, hostname, log level etc
• SCIM related cofiguration such as resource schemas for Users, and Groups
• Kubernetes deployment, service and ingress configuration

Swagger UI

OpenAPI specification and Swagger go hand-in-hand and the latter is a great tool for helping developers discover all the requests supported by an API and execute them as well. The uid-server exposes a Swagger UI under https://$HOSTNAME/swagger which contains all the available operations including details about how to make the requests.

Admin UI (beta)

Currently the admin UI is disabled by default because it is still in beta, however when enabled, you can see runtime information, configuration change settings on the fly without the need to restart the server.

Developer friendly

Developers can spin up a Docker container running the uid-server in their local machine with just one docker run command or a single click if using Docker Desktop. This way, the setup of the cloud infrastructure running the production environment is decoupled from the development of the business application that will use it. In a large organization the process of setting up a production grade environment and what it entails can take a significant amount of time. Hence, the simple local deployment process allows developers to start implementing their application earlier.

What's next?

This is not just about enabling enterprises handle their users identities. It is also about empowering individual users to manage the way their digital identity is used online in a simple, understandable and secure manner.