The Users object is a special object within the Skedulo Pulse Platform, as it stores information that is used in the identification of users, and is linked to authorisation mechanisms. As such, there have been restrictions on how you can modify certain fields.
Updating fields on User object via GraphQL
Prior to this release, it was not possible to update the Users object via GraphQL, which severely limited the usefulness of any custom fields 🤦.
We now support "update" mutations for all fields on the Users object (including custom fields) via the GraphQL API. However, the Email field may only be updated for users that authenticate via SSO.
This means you can now make use of custom fields on the Users object for storing additional information associated with the user.
Given the special nature of the Users object, other mutations such as insert, upsert and delete are still not supported via GraphQL.
Please note: the Data import/export tool does not use GraphQL for the User object, so it cannot modify custom fields on it.
Updates to the User.Email field now supported for SSO users
The User.Email field is used to uniquely identify a user and must match the user’s primary ID in their SSO identity provider. Note that for SSO users, we don’t send emails to the user’s email address.
For more information on the User.Email field, please refer to the documentation.
Prior to this release it was not possible to update values in the User.Email field.
To better support SSO management use cases for Pulse Platform customers we now support updates to this field if the User.IsManaged field equals FALSE, indicating this user is authenticated via Single Sign On (SSO).
You can update the User.Email field for SSO users via:
- Editing a user in web app settings (Settings > Users & roles > Users)
- The Data import/export tool
- The Onboarding API
- The GraphQL API
Example of how to modify an SSO user’s email via the Onboarding API
To modify a SSO user's email address, simply submit a request to the Onboarding API with the following details. Remember to use the correct SKEDULO_API_URL for your region.
URL: https:///onboarding/provision/standalone/users
METHOD: PATCH
PAYLOAD:
{
"00010e51-6f40-4028-8b6a-77f738671***": {
"email": "[email protected]"
},
"000126c6-4d4c-404f-989e-56cd567ba***": {
"email": "[email protected]"
}
}
Changing email address for non-SSO users?
If you need to change an email address for a non-SSO user, please contact technical support.