OneRosterLinkedUsersOutput

Linked users for a specific user through agent relationships

agentsAsAgent
Type: array object[] · LinkedUser[]
required

Users where the current user is acting as an agent (e.g., children of a parent)
A linked user with relationship information
- agentId
  Type: stringFormat: uuid
  required
  
  Unique identifier for this agent relationship. This is the same UUID used in upsertStudentAgent and deleteStudentAgent operations.
- relationshipType
  Type: string
  required
  
  Type of agent relationship (e.g., parent, guardian)
- userId
  Type: string
  required
  
  The user ID of the linked user
agentsAsSource
Type: array object[] · LinkedUser[]
required

Users who are agents of the current user (e.g., parents of a student)
A linked user with relationship information
- agentId
  Type: stringFormat: uuid
  required
  
  Unique identifier for this agent relationship. This is the same UUID used in upsertStudentAgent and deleteStudentAgent operations.
- relationshipType
  Type: string
  required
  
  Type of agent relationship (e.g., parent, guardian)
- userId
  Type: string
  required
  
  The user ID of the linked user