System for Cross-domain Identity Management (v2.0)

GoFormz supports SCIM, or System for Cross-domain Identity Management, an open standard that allows you to automate user provisioning using a REST API and JSON. The GoFormz SCIM API follows version 2.0 of the SCIM protocol.

For more information, visit our ServiceProviderConfigs endpoint on what is supported.

📘

Authentication

Our SCIM2.0 endpoints support the same authentication protocols as our API.

User Endpoints

For additional information on what is supported, visit our User Schema endpoint.

Purpose

API

Notes

Get Users

GET /scim/v2/Users

Return a list of users and with a 200 status code if successful.

Supports:

  • filtering by username, ie. 'username eq {username}'
  • pagination

Get User Details

GET /scim/v2/Users/{id}

Returns details of a user with the given {id} and with a 200 status code if successful.

Update User

PUT /scim/v2/Users/{id}

Update supported user details:

  • Username
  • Firstname
  • Lastname
  • Phone Number
  • Active (use for deactivating/reactivating a user)
    Returns a 200 status code if successful.

Create User

POST /scim/v2/Users

Password is optional

Returns a new user with a 201 status code if successful.

Groups Endpoints

For additional information on what is supported, visit our Group Schema endpoint.

Purpose

API

Notes

Get Groups (and Members)

GET /scim/v2/Groups

Returns a list of groups and all members, with a 200 status code if successful.

Supports:

  • filtering by displayname, ie. 'displayname eq {displayname}'
  • pagination

Get Group Details (and Members)

GET /scim/v2/Groups/{id}

Returns details of a group with a given {id} and all members, with a 200 status code if successful.

Update Group (and Members)

PUT /scim/v2/Groups/{id}

Update supported group details:

  • Display Name
  • Members

Returns a 200 status code if successful.

Create Group

POST /scim/v2/Groups

Returns a new group with a 201 status code if successful.

Delete Group

DELETE /scim/v2/Groups/{id}

Returns a 204 status code and not content if successful.