VEverkada
Access Groups

Add User to Access Group

Add an access user to an access group with the Verkada defined group ID and either the user defined External ID or the Verkada defined user ID. The group ID is passed in as query parameter in the URL. The external ID or Verkada user ID(but not both) is passed in the json object in the body of the request.

put/access/v1/access_groups/group/user

Request

  • Base URL
    https://api.verkada.com
  • URL
    https://api.verkada.com/access/v1/access_groups/group/user
  • Auth
    • API key in header x-verkada-auth
    • or API key in header x-api-key

Query parameters

group_idstring uuid required

The unique identifier of the Access Group managed by Verkada.

Request body

external_idstring

A unique identifier managed externally provided by the customer.

user_idstring uuid

The unique identifier of the user managed by Verkada.

Response

OK

group_idstring uuid

The unique identifier of the Access Group managed by Verkada.

namestring

The unique name of the Access Group provided by the customer.

successful_addsstring[]

The list of successfully added Verkada-defined user identifiers.

unsuccessful_addsstring[]

The list of unsuccessfully added Verkada-defined user identifiers.

Changes

No recorded changes to this operation across all 1 revision of this API.