Genesys Cloud - Developer Community!

 View Only

Sign Up

Expand all | Collapse all

How to use SCIM APIs to create/update an user with given Location/PreferredName/Name?

  • 1.  How to use SCIM APIs to create/update an user with given Location/PreferredName/Name?

    Posted 06-04-2025 06:21

    Hi,

    May I check if anyone knows how to use SCIM APIs to create/update a Genesys user object satisfying following field requests?

    • Creating/Updating User object to add a Location to it
    • Creating/Updating User object to set its PreferredName value
    • Creating/Updating User object to set its Name value

    if not, any workaround to update those user object fields?.


    Thank you!

    Jun


    #PlatformSDK

    ------------------------------
    Jun Xu
    ------------------------------


  • 2.  RE: How to use SCIM APIs to create/update an user with given Location/PreferredName/Name?

    Posted 06-11-2025 10:54

    Hello Jun,

    Thanks for your interest in our SCIM integration.

    As I understand you are looking for ways to synchronize additional fields via the SCIM payload, besides the one that the default SCIM user schema defines.

    There are two ways to check what attributes SCIM supports as of today:

    1. The easy way is to consult our documentation which is kept up to date whenever a new attribute mapping support is added via an extension: https://help.mypurecloud.com/articles/scim-and-genesys-cloud-field-mappings/

    2. The other is through our APIs for which our API Explorer provides an easy access to. You can query the fields supported via scim/v2/schemas/{schemaId} endpoint, and if you use the explorer it provides you a pointer what schemas we have available and thus through that what attributes are supported.




    That said, Location is at the moment not supported, you can use the displayName field to set the value that will be visible in Collaborate Chat which is the closest to the Preferred Name concept I believe.

    Let me know if this helps to see what our SCIM integration is capable of.

    Best regards,
     Maverick



    ------------------------------
    Istvan Vajnorak
    Senior Director, Cloud Engineering
    ------------------------------