Members

Add organization user to zone

client.zones.members.add(, , ?): ZoneMember { id, _links, created_at, 5 more }

POST/zones/{zoneId}/members

List organization users in a zone

client.zones.members.list(, ?, ?): MemberListResponse { items, page_info, pagination }

GET/zones/{zoneId}/members

Get organization user in a zone

client.zones.members.retrieve(, , ?): ZoneMember { id, _links, created_at, 5 more }

GET/zones/{zoneId}/members/{organizationUserId}

Update organization user role in a zone

client.zones.members.update(, , ?): ZoneMember { id, _links, created_at, 5 more }

PATCH/zones/{zoneId}/members/{organizationUserId}

Remove member from zone

client.zones.members.delete(, , ?): void

DELETE/zones/{zoneId}/members/{organizationUserId}

ModelsExpand Collapse

ZoneMember { id, _links, created_at, 5 more }

Represents an organization user's membership in a zone with an assigned role

id: string

Unique identifier of the zone member

_links: _Links { organization_user, self }

HAL-format hypermedia links for zone member resources

organization_user: OrganizationUser { href }

href: string

Link to the user resource

formaturi-reference

self: Self { href }

href: string

Link to this zone member resource

formaturi-reference

created_at: string

Entity creation timestamp

formatdate-time

organization_id: string

Organization ID that owns the zone

organization_user_id: string

Organization user ID of the zone member

role: ZoneRole

Zone role type. zone_manager has full management access, zone_viewer has read-only access.

Accepts one of the following:

"zone_manager"

"zone_viewer"

updated_at: string

Entity update timestamp

formatdate-time

zone_id: string

Zone ID the organization user is a member of

ZoneRole = "zone_manager" | "zone_viewer"

Zone role type. zone_manager has full management access, zone_viewer has read-only access.

Accepts one of the following:

"zone_manager"

"zone_viewer"