what user permissions are needed to update the users data using /d2l/api/lp/1.35/users/

Holly.S.916
Holly.S.916 Posts: 3 🌱
edited September 12 in Development

Hi, we are trying to update pronouns from our SIS into Brightspace using APIs and are currently testing. We get a permissions error when attempting to run /d2l/api/lp/1.35/users/

Can we get a list of all permissions needed to successfully make this call?

Thank you,

Holly

Tagged:
· Share on Twitter

Answers

  • Ivan.N.979
    Ivan.N.979 Posts: 4

    Hello Holly,

    Thank you for contacting us through the Brightspace community!

    https://docs.valence.desire2learn.com/res/user.html#id3 According to our API documentation: This action is subject to user privacy controls. The calling user context must belong to a role granted permission to see all user fields via User Information Privacy.

    image.png image.png

    Thank you,

    Ivan

    · Share on Twitter
  • Holly.S.916
    Holly.S.916 Posts: 3 🌱

    Ok that's great Ivan, thank you! I have a couple other questions if you wouldn't mind having a look.

    1. It looks like we have to update all the fields on the user profile with when using the API, but we only want to update the pronoun field. We can workaround this, but we’d like to know if it’s possible to update just the pronoun field using the API.
    2. We’d like to set the showpronouns field to turn on viewing of pronouns got students who have consented to having their pronouns displayed in our SIS. We’re using the /d2l/api/lp/(version)/users/mypronouns/visibility. Our developer is able to update his own showporonouns field using the API, but we need to know if/how we can use it to update the showpronouns field for all students.

    Thank you for your help!

    Holly

    · Share on Twitter
  • Travis.H.362
    Travis.H.362 Posts: 25 Analytics Builder Transition

    Hi @Holly.S.916 - were you able to find a solution for item 2 that you listed related to updating the showpronouns field for all students? I'm running into the same restriction.

    · Share on Twitter
  • Mian.R.3574
    Mian.R.3574 Posts: 14 🤝🏼
    edited September 12

    Hello Holly and Travis,

    To answer your questions:

    1. Unfortunately, it is not possible to update a user's pronouns alone; you will need to include the whole block of all the user attributes there, even if the rest remain the same.
    2. You cannot update pronoun visibility through the API for a specific user. You may only update your own, in this case, the developer who is connected to the API. Users can manually turn this setting on by navigating to 'Account Settings' and checking the 'Allow others to see my pronouns' box.

    This is a document put together by Brightspace that includes all the API calls you may use to your advantage.

    I hope that helps!

    Kind Regards,

    Mian

    · Share on Twitter

Categories