Grant a permission to a user within an entity

POST /entities/{id}/users/{targetUserId}/permissions

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 path

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.

permission enum Required

No description.

Possible values: users:addusers:removepermissions:addpermissions:removemetadata:updatepaymentAccounts:addpaymentAccounts:updatepaymentAccounts:viewincomingPayments:viewincomingPayments:processoutgoingPayments:createoutgoingPayments:view +4 more

x-tenant-id string Required header

Tenant identifier. Required on all tenant-scoped routes.

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

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

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

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