Skip to main content

SubjectSummary

Subject identity returned by the API, including its identifier, type, display name, and optional avatar data. email is returned only when type is user.

idId (string)required

"user." | "group." | "public.all"

typeType (string)required

Possible values: [user, group, public]

display_nameDisplay Name (string)required
avatar_url object
anyOf
string
avatar_config object
anyOf
object
email object
anyOf
string<email>
SubjectSummary
{
"id": "string",
"type": "user",
"display_name": "string",
"avatar_url": "string",
"avatar_config": {},
"email": "user@example.com"
}