Add organization user to zone

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

POST/zones/{zoneId}/members

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

ParametersExpand Collapse

zoneID string

body ZoneMemberAddParams

OrganizationUserID param.Field[string]

Organization user ID to add to the zone

Role param.Field[ZoneRole]

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

ReturnsExpand 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

Add organization user to zone

package main

import (
  "context"
  "fmt"

  "github.com/keycardai/keycard-go"
)

func main() {
  client := keycard.NewClient(

  )
  zoneMember, err := client.Zones.Members.Add(
    context.TODO(),
    "zoneId",
    keycard.ZoneMemberAddParams{
      OrganizationUserID: "organization_user_id",
      Role: keycard.ZoneRoleZoneManager,
    },
  )
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", zoneMember.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"
}