cam · 2019-01-16

ListEntitiesForPolicy

POST

Query the list of entities associated with a policy.

Wire call

Converge Cloud is RPC over HTTP. There is one path — / — and the action travels in the X-TC-Action header. The /cam/ListEntitiesForPolicy path used in the OpenAPI document is a documentation convenience so each action is addressable; it is not a route on the server.

curl

curl -sS https://cam.api3.convergecloud.com/ \
  -H 'Authorization: TC3-HMAC-SHA256 Credential=<SecretId>/<YYYY-MM-DD>/cam/tc3_request, SignedHeaders=content-type;host;x-tc-action, Signature=<sig>' \
  -H 'Content-Type: application/json; charset=utf-8' \
  -H 'Host: cam.api3.convergecloud.com' \
  -H 'X-TC-Action: ListEntitiesForPolicy' \
  -H 'X-TC-Version: 2019-01-16' \
  -H 'X-TC-Timestamp: <unix-seconds>' \
  -H 'X-TC-Region: luzon' \
  -d '{}'

Request parameters

Field	Type	Required	Description
PolicyId	integer	Yes	Policy ID
Page	integer	No	Page number, which starts from 1. Default is 1
Rp	integer	No	Number of entries per page; 20 by default
EntityFilter	string	No	Valid values: `All`, `User`, `Group`, and `Role`. `All` means all entity types will be returned; `User` means only sub-accounts will be returned; `Group` means only User Groups will be returned; `Role` means only roles will be returned. `All` is the default value.

Response

Fields are returned inside the Response envelope. Converge Cloud answers HTTP 200 for errors as well as successes, so read Response.Error rather than the status code — and test for the presence of that object, because Code is occasionally the empty string.

Field	Type	Description
TotalNum	integer	Number of entities
List	AttachEntityOfPolicy[]	Entity list
RequestId	string	The unique request ID, which is returned for each request. RequestId is required for locating a problem.

Success

{
  "Response": {
    "TotalNum": …,
    "List": …,
    "RequestId": "…"
  }
}

Error

{
  "Response": {
    "Error": { "Code": "…", "Message": "…" },
    "RequestId": "…"
  }
}

Try it

CredentialThe key never leaves this tab — it signs the request here. The signed request goes to /api-relay/cam.

SecretIdSecretKey

Request bodyvalid JSONPOST cam.api3.convergecloud.com · ListEntitiesForPolicy

{}

Read-only. Creates nothing.

Recorded example response — captured 2026-09-16

{
  "Response": {
    "List": [],
    "RequestId": "6bb8b9ee-d4b6-201a-cc6c-f90bb5cf13cc",
    "TotalNum": 0
  }
}