Skip to main content
Section ID: DOC-API-MODEL-schema-pql723cqr4#overview

UserSet

UserSet represents the expanded result of users with a specific relation to an object

Type-reference view: API Schema 62c40oktj2. Request and response views describe this type; they do not declare an endpoint.

Meaning and usage​

Section ID: DOC-API-MODEL-schema-pql723cqr4#meaning

See the definition above.

Usage profiles​

Section ID: DOC-API-MODEL-schema-pql723cqr4#fields

UsageFields and validation
In requestsView fields
In responsesView fields

In requests​

Section ID: DOC-API-MODEL-schema-pql723cqr4#request

API JSON uses JSON field names (camelCase).

FieldTypePresenceMeaning
Section ID: DOC-API-MODEL-schema-pql723cqr4#request-field-usersusersArray of stringOptionalDirect user relations.
Section ID: DOC-API-MODEL-schema-pql723cqr4#request-field-teamsteamsArray of stringOptionalTeam/group relations.
Section ID: DOC-API-MODEL-schema-pql723cqr4#request-field-computedcomputedArray of stringOptionalComputed/derived relations through inheritance.

In responses​

Section ID: DOC-API-MODEL-schema-pql723cqr4#response

API JSON uses JSON field names (camelCase).

FieldTypePresenceMeaning
Section ID: DOC-API-MODEL-schema-pql723cqr4#field-usersSection ID: DOC-API-MODEL-schema-pql723cqr4#response-field-usersusersArray of stringOptionalDirect user relations.
Section ID: DOC-API-MODEL-schema-pql723cqr4#field-teamsSection ID: DOC-API-MODEL-schema-pql723cqr4#response-field-teamsteamsArray of stringOptionalTeam/group relations.
Section ID: DOC-API-MODEL-schema-pql723cqr4#field-computedSection ID: DOC-API-MODEL-schema-pql723cqr4#response-field-computedcomputedArray of stringOptionalComputed/derived relations through inheritance.

Where used​

Section ID: DOC-API-MODEL-schema-pql723cqr4#where-used

ReferenceRelationship
UserSetAPI JSON uses JSON field names (camelCase).

Download the public reference contract.

Document ID: DOC-API-MODEL-schema-pql723cqr4