Inconsistent user visibility in APIs for directory setting

Eric Eskildsen
Eric Eskildsen
Sixth Anniversary Kudos 1 Name Dropper Participant
in Education Management APIs

Hi all - not sure if this is a bug or as designed.

One of our schools has some students set to Do not include my name or any information about me in the directory. (This is under User Profile > Settings > Privacy settings > Directory Settings. Screenshot at bottom.)

That excludes them from some API endpoints but not others. Examples:

  • /school/v1/users: Excluded
  • /school/v1/users/extended: Included
  • /school/v1/athletics/teams/{team_id}/roster: Excluded-ish (the user is in the roster, but their user ID is 0)
  • /oneroster/v1p1/users: Included

We combine data from multiple endpoints, so we're trying to understand what all that setting affects.

23c731507323971f9fcf4735f983c3a6-huge-im

Comments

  • Todd DeSchuiteneer
    Todd DeSchuiteneer Blackbaud Employee
    Tenth Anniversary Kudos 3 Name Dropper Participant

    @Eric Eskildsen with the exception of the /school/v1/users endpoint, the functionality mentioned is intended. I'll go ahead and create another ticket for that and proceed with the investigation there.

Categories