universalid/scim repository overview

⁠Get Started

⁠Prerequisites

Universal ID SCIM 2.0 server requires a running PostgreSQL (16+) database.

Download PostgreSQL: https://www.postgresql.org/download/⁠

⁠Run with Dev profile

docker run -t --net=host universalid/scim:$tag dev

• -t attaches a pseudo-TTY to the container, connecting your terminal to the I/O streams of the container.
• --net=host uses host network. Alternatively, you can pass each port mapping individually (required ports: 8080, 8443). e.g. -p 8080:8080
• dev loads a zero config profile for development.

Dev profile starts with DEBUG logging enabled, listens to port 8080 and connects to a PostgreSQL database with default settings:

• name: postgres
• port: 5432
• username: postgres
• password: postgres

It also loads the SCIM 2.0 User and Group schemas along with one extension schema example:

• urn:ietf:params:scim:schemas:core:2.0:User
• urn:ietf:params:scim:schemas:core:2.0:Group

(see: https://datatracker.ietf.org/doc/html/rfc7643#autoid-22⁠)

extension schema example:

• urn:se:universalid:extension:Device

Once the application is running you can query via GET the /Schemas path to get a detailed description of the Schemas and their attributes.

⁠Run with a custom profile

Create a config directory with a file named application.yaml. For a minimal production configuration the following components must be configured:

• Datasource configuration
• Client Authentication
• Resources
• Schemas

More information about how to configure the above components: https://docs.universalid.app/docs/configuration/⁠

If Client Auth is enabled create an additional directory named crypto containing the following 2 sub-directories: server-keystore and server-truststore. In the first directory place the server certificate (single PKCS#12 file) and in the latter the trusted client certificates (single PKCS#12 file also).

Mount the config and crypto (if Client Auth is enabled) directories to the container filesystem under /deployments/:

docker run -t --net=host \
  --mount type=bind,src=/path/to/universalid/config,dst=/edployments/config \
  --mount type=bind,src=/path/to/universalid/crypto,dst=/deployments/crypto universalid/scim:$tag custom

⁠Useful links

• Universal ID homepage: https://www.universalid.se⁠
• Documentation: https://docs.universalid.app⁠
• OpenAPI specification: https://docs.universalid.app/api⁠

⁠Usage

The following operations do not require a license:

• Create: POST https://example.com/v2/{resource}⁠
• Read: GET https://example.com/v2/{resource}/{id}⁠
• Search: GET https://example.com/v2/{resource}?filter={attribute}{op}{value}&sortBy={attributeName}&sortOrder={ascending|descending}⁠
• Search: POST https://example.com/v2/{resource}/.search⁠

⁠Enterprise license

Additional operations:

• Replace: PUT https://example.com/v2/{resource}/{id}⁠
• Delete: DELETE https://example.com/v2/{resource}/{id}⁠
• Update: PATCH https://example.com/v2/{resource}/{id}⁠
• Bulk: POST https://example.com/v2/Bulk⁠

For purchasing an enterprise license contact us through https://www.universalid.se/support⁠ or send an email directly to [email protected]⁠

A license is a flat annual fee which unlocks all the features of Universal ID and includes:

• Regular feature and security releases
• Feature requests
• Slack support channel during business hours
• 24/7 phone line for critical production incidents
• Access to Identity Specialists who can help with integration
• Custom SLA