Skip to main content

Mapping Custom Okta Fields through SCIM

in Okta SCIM setup
Authors list
Published: 3 Oct 2024|Last updated: 3 Oct 2024

If you would like to sync additional user information from your Okta directory into Deskpro using the SCIM sync, you will need to map custom fields within Okta.

You can add custom user fields, and these will be added to your SCIM schema. You can then map the schema attributes to the attributes within Okta, and those values will be updated and maintained automatically through the SCIM sync.

What do I need from Deskpro?Copy link to What do I need from Deskpro? to clipboard

In order to map the attributes successfully, you need to confirm 3 pieces of information from Deskpro for each custom user field.

  1. The schema

  2. The attribute

  3. The type

By default, custom fields will use the schema urn:ietf:params:scim:schemas:extension:enterprise:2.0:User This is referred to as the External namespace in Okta

The attribute is the name of the custom field in lower-case, with punctuation stripped and spaces replaced by dashes (-). i.e. a custom field named "Some User's Field" would be formatted as some-users-field

The type is the type of field it is, such as a string, boolean, dateTime etc.

Please note that type doesn't necessarily match the type within Deskpro. The table below should allow you to match the attribute type to the field type:

Field Type (Deskpro)

Attribute Type (SCIM)

Single-line Text

string

Number

string

Multi-line Text

string

Select

string / string array

Toggle

boolean

Display

string

Hidden

string

URL

string

Currency

integer

These can also be found in your SCIM schemas. You can view a JSON output of the available schemas by visiting https://your.helpdesk.url/scim/Schemas.

Mapping the fields within OktaCopy link to Mapping the fields within Okta to clipboard

In Okta, go to Applications > Applications then select your Deskpro SAML application.

Under the Provisioning tab, scroll to the User Attribute Mappings section and click Go to Profile Editor

Adding an attributeCopy link to Adding an attribute to clipboard

Before you can map the attribute in Okta, you need to create the attribute. In the Profile Editor, scroll to the Attributes list and click Add Attribute

image.png

In the Add Attribute form, fill out the following fields:

  • Data Type - Select the appropriate attribute type from the table above

  • Display Name - An identifiable name

  • Variable Name - A unique name which Okta can use in mappings and expressions.

  • External Name - The name of the attribute in the Deskpro SCIM schema (see above)

  • External Namespace - urn:ietf:params:scim:schemas:extension:enterprise:2.0:User

All other values are optional.

Click Save to continue, or Save and Add Another if you need to add multiple attributes.

Mapping the attributesCopy link to Mapping the attributes to clipboard

Once the attribute has been created in Okta, you can now map the attribute.

At the top of the Attributes table, click Mappings.

As we are mapping the data from Okta into Deskpro, select Okta User to {Your Application} from the top of the form.

If you scroll to the bottom of the form, you should see the new attributes you have added on the right-hand side, and you should had the option to Choose an attribute or enter an expression on the left-hand side.

image.png

You can either select the Okta attribute you wish to map from the list, or type an expression if you need to modify the value before sending.

Once the mappings have been saved, they should update in Deskpro the next time SCIM updates.

HelpfulUnhelpful
next pageGoogle+ Setup
previous pageOkta SCIM setup

Please log in or register to submit a comment.