Add a user to an entity

POST /entities/{id}/users

Parameters

id string Required path

The unique ID of the resource being addressed. See the id field in the parent resource's list or GET-by-ID response.

targetUserId string Required

The unique ID of the user being acted on. Same source as userId — usually the id field from a user list endpoint or GET /users/me.

x-tenant-id string Required header

Tenant identifier. Required on all tenant-scoped routes.

More parameters Expand all

permissions array of enums

No description.

curl -X POST "https://heimdall.qa.zoniqx.com/entities/<id>/users" \ -H "Authorization: Bearer <accessToken>" \ -H "x-tenant-id: <your-tenant-id>" \ -H "Content-Type: application/json" \ -d '{ "targetUserId": "string", "permissions": [ "users:add" ] }'

const response = await fetch("https://heimdall.qa.zoniqx.com/entities/<id>/users", { method: "POST", headers: { "Authorization": "Bearer <accessToken>", "x-tenant-id": "<your-tenant-id>", "Content-Type": "application/json", }, body: JSON.stringify({ "targetUserId": "string", "permissions": [ "users:add" ] }), }); const data = await response.json();

type EntitiesController_addEntityUserResponse = Record<string, unknown>; const response = await fetch("https://heimdall.qa.zoniqx.com/entities/<id>/users", { method: "POST", headers: { Authorization: "Bearer <accessToken>", "x-tenant-id": "<your-tenant-id>", "Content-Type": "application/json", }, body: JSON.stringify({ "targetUserId": "string", "permissions": [ "users:add" ] }), }); const data: EntitiesController_addEntityUserResponse = await response.json();

import requests url = "https://heimdall.qa.zoniqx.com/entities/<id>/users" headers = { "Authorization": "Bearer <accessToken>", "x-tenant-id": "<your-tenant-id>", } payload = { "targetUserId": "string", "permissions": [ "users:add" ] } response = requests.post(url, headers=headers, json=payload) data = response.json()