Skip to content
Docs
Members

Remove group member

Remove group member

client.Zones.Groups.Members.Remove(ctx, userID, body) error
DELETE/zones/{zoneId}/groups/{groupId}/members/{userId}

Removes a user from a group managed in Keycard. Membership of externally synced groups is not managed manually. A member is identified by its user's ID.

ParametersExpand Collapse
userID string
body ZoneGroupMemberRemoveParams
ZoneID param.Field[string]

Zone ID

GroupID param.Field[string]

Group ID

Remove group member

package main

import (
  "context"

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

func main() {
  client := keycard.NewClient(
    option.WithAPIKey("My API Key"),
  )
  err := client.Zones.Groups.Members.Remove(
    context.TODO(),
    "userId",
    keycard.ZoneGroupMemberRemoveParams{
      ZoneID: "zoneId",
      GroupID: "groupId",
    },
  )
  if err != nil {
    panic(err.Error())
  }
}
Returns Examples