About the SCIM API
Overview
System for Cross-domain Identity Management, also known as SCIM, provides automated provisioning and user management for Mural Enterprise accounts. SCIM will help your team create matching user accounts in all systems that your team needs access to. By adding SCIM to Mural, we hope to streamline your workflows and help your team grow in Mural.
Prerequisites
SSO (SAML-based single sign-on) must be properly set up and functional in your Enterprise account before you start configuring automated provisioning.
Supported features
Detailed Mural SCIM schema can be found in our SCIM resource sheet.
Mural supports the following provisioning features:
-
GET /Users
Get an overview of the members with a Mural license. -
GET /Users/{id}
Check the attributes of a member. -
POST /Users
Create a new Mural account. -
PATCH /Users/{id}
Update an existing member's resource and overwrite values for specific attributes. -
PUT /Users/{id}
Update an existing member's resource, overwriting all values for a member. -
DELETE /Users/{id}
Delete a member. This is a hard delete, erasing the user's identity data from Mural.
Note: For a soft delete enabling user reactivation, use a PATCH call to set 'active' == ‘false’. -
GET /Groups
Get an overview of your groups. -
GET /Groups/{id}
Check the attributes of a group. -
POST /Groups
Create a new Mural group with members. -
PATCH /Groups/{id}
Update an existing group’s resource. Either add, remove, or replace members to the group. -
DELETE /Groups/{id}
Deactivate a group to revoke members' access to the mapped Mural workspace(s).
Supported attributes
In Mural, each member has their own attributes linked to their Mural account. Attributes are profile information that a member would typically set in the Profile Details page of their Mural account. These attributes include the member's first name, last name, and email.
User attributes
Mural profile field | SCIM attribute |
---|---|
name | givenName |
surname | familyName |
userName | |
N/A | userType |
locked | active |
avatar | profileUrl |
username | id |
Group attributes
Groups are for organizing your members in logical divisions across your Mural workspaces. Examples would be grouping by department or by region. Attributes are details associated with a group, including the unique group displayName
. Members should be added to a group.
Configure the SCIM API
Mural's SCIM implementation targets the SCIM 2.0 protocol reference. To set up automated SCIM provisioning, follow the steps in our Automatic SCIM provisioning article. To map SCIM groups to workspaces and set permissions, follow the steps outlined in our article, Managing user accounts through SCIM groups. You can also test in our sandbox environment.
Updated 7 months ago