Add organization user to zone

zones.members.add(, ) -> ZoneMember

POST/zones/{zoneId}/members

Adds an organization user to a zone with the specified role.

ParametersExpand Collapse

zone_id: str

organization_user_id: str

Organization user ID to add to the zone

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"

ReturnsExpand Collapse

class ZoneMember: …

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

id: str

Unique identifier of the zone member

_links: _Links

HAL-format hypermedia links for zone member resources

organization_user: _LinksOrganizationUser

href: str

Link to the user resource

formaturi-reference

self: _LinksSelf

href: str

Link to this zone member resource

formaturi-reference

created_at: datetime

Entity creation timestamp

formatdate-time

organization_id: str

Organization ID that owns the zone

organization_user_id: str

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

Entity update timestamp

formatdate-time

zone_id: str

Zone ID the organization user is a member of

Add organization user to zone

from keycardai_api import KeycardAPI

client = KeycardAPI()
zone_member = client.zones.members.add(
    zone_id="zoneId",
    organization_user_id="organization_user_id",
    role="zone_manager",
)
print(zone_member.id)

{
  "id": "id",
  "_links": {
    "organization_user": {
      "href": "href"
    },
    "self": {
      "href": "href"
    }
  },
  "created_at": "2019-12-27T18:11:19.117Z",
  "organization_id": "organization_id",
  "organization_user_id": "organization_user_id",
  "role": "zone_manager",
  "updated_at": "2019-12-27T18:11:19.117Z",
  "zone_id": "zone_id"
}

Returns Examples

{
  "id": "id",
  "_links": {
    "organization_user": {
      "href": "href"
    },
    "self": {
      "href": "href"
    }
  },
  "created_at": "2019-12-27T18:11:19.117Z",
  "organization_id": "organization_id",
  "organization_user_id": "organization_user_id",
  "role": "zone_manager",
  "updated_at": "2019-12-27T18:11:19.117Z",
  "zone_id": "zone_id"
}