Skip to main content
Version: 3.4.0-rc.1

User Schemas

ResourceUser Object​

PropertyTypeDescription
idstringUnique identifier for the user.
scopestringThe scope of access for the user (e.g., "view", "admin").
emailstringEmail address of the user.
usernamestringUsername of the user.

JSON Example​

{
"id": "user-123",
"scope": "admin",
"email": "[email protected]",
"username": "johndoe"
}

PatchResourceUser Object​

PropertyTypeDescription
idstringUnique identifier for the user.
scopestringThe new scope of access for the user.

JSON Example​

{
"id": "user-123",
"scope": "view"
}