Members

Add organization user to zone

client.Zones.Members.Add(ctx, zoneID, body) (*ZoneMember, error)

POST/zones/{zoneId}/members

List organization users in a zone

client.Zones.Members.List(ctx, zoneID, query) (*ZoneMemberListResponse, error)

GET/zones/{zoneId}/members

Get organization user in a zone

client.Zones.Members.Get(ctx, organizationUserID, query) (*ZoneMember, error)

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

Update organization user role in a zone

client.Zones.Members.Update(ctx, organizationUserID, params) (*ZoneMember, error)

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

Remove member from zone

client.Zones.Members.Delete(ctx, organizationUserID, body) error

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

ModelsExpand Collapse

type ZoneMember struct{…}

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

ID string

Unique identifier of the zone member

Links ZoneMember_Links

HAL-format hypermedia links for zone member resources

OrganizationUser ZoneMember_LinksOrganizationUser

Href string

Link to the user resource

formaturi-reference

Self ZoneMember_LinksSelf

Href string

Link to this zone member resource

formaturi-reference

CreatedAt Time

Entity creation timestamp

formatdate-time

OrganizationID string

Organization ID that owns the zone

OrganizationUserID 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:

const ZoneRoleZoneManager ZoneRole = "zone_manager"

const ZoneRoleZoneViewer ZoneRole = "zone_viewer"

UpdatedAt Time

Entity update timestamp

formatdate-time

ZoneID string

Zone ID the organization user is a member of

type ZoneRole string

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

Accepts one of the following:

const ZoneRoleZoneManager ZoneRole = "zone_manager"

const ZoneRoleZoneViewer ZoneRole = "zone_viewer"