Learn how to create and map custom attributes as a part of user provisioning to the Staffbase platform using SCIM.
In this article, you will learn how to create and map custom attributes to provision users from your identity provider to the Staffbase platform using
You can define the SCIM schema for user attributes and extend it with custom attributes. These custom attributes can be specific for your Staffbase platform users.
For example, you can create additional custom profile fields to record the skills of your users in the Staffbase platform. If you want to automatically provision values to a custom profile field using SCIM, do the following:
The schema for creating the custom attributes is urn:ietf:params:scim:schemas:extension:{{CompanyName}}:2.0:User:{{CustomAttribute}}
, you need to input the values within {{ }}
.
Here, CompanyName
is the name of your company and CustomAttribute
is the name you want to give the new custom attribute that you want to create.
If your CompanyName
is showcase
and the custom attribute you want to create is custom_department
.
The schema will look like this: urn:ietf:params:scim:schemas:extension:showcase:2.0:User:custom_department
.
The schema for creating custom attributes is the same for all Staffbase supported identity providers. Learn more about the identity providers that Staffbase supports.
In the same section where you configured your default mappings, you can also add custom attributes to provision to custom profile fields in Staffbase.
department
.urn:ietf:params:scim:schemas:extension:{CompanyName}:2.0:User
where {CompanyName}
needs to be replaced with the name of your company.Example Department Custom Attribute
urn:ietf:params:scim:schemas:extension:{CompanyName}:2.0:User:{CustomField}
{CompanyName}
is showcase{CustomField}
is custom_departmenturn:ietf:params:scim:schemas:extension:showcase:2.0:User:custom_department
custom_department
urn:ietf:params:scim:schemas:extension:showcase:2.0:User
Click Save to add the new attribute.
Once you have added all your new attributes, go back to your Application.
In your application, select Provisioning > To App.
Click Show Unmapped Attributes.
If one of the options is not available, SCIM might not yet be enabled for updates.
Now you can give the custom attribute schema you created to the Staffbase administrator, who will configure the custom profile field. Learn more here.
In our example, the custom attribute schema looks like this: urn:ietf:params:scim:schemas:extension:showcase:2.0:User:custom_department
After the custom profile field in the Staffbase Studio is configured with the custom attribute, the custom attribute may not get provisioned the first time you provision users. You might want to test it with Force Sync to ensure it works as expected.