Note: The
topic path of policy commands contains no
channel element.
See the
specification for details.
Retrieve a Policy
Retrieves a Policy identified by the <namespace>/<policyName> pair in the topic field.
Command
| Field |
Value |
| topic |
<namespace>/<policyName>/policies/commands/retrieve |
| path |
/ |
Response
| Field |
|
Value |
| topic |
|
<namespace>/<policyName>/policies/commands/retrieve |
| path |
|
/ |
| value |
|
The Policy as JSON object, see Policy representation (JSON). |
| status |
code |
|
| |
200 |
Success. |
Example: Retrieve a Policy
Retrieve Policy entries
Retrieves all entries of the policy identified by the <namespace>/<policyName> pair in the topic field.
Command
| Field |
Value |
| topic |
<namespace>/<policyName>/policies/commands/retrieve |
| path |
/entries |
Response
| Field |
|
Value |
| topic |
|
<namespace>/<policyName>/policies/commands/retrieve |
| path |
|
/entries |
| value |
|
The Policy entries as JSON object, see Policy representation (JSON). |
| status |
code |
|
| |
200 |
Success. |
Example: Retrieve all Policy entries
Retrieve a Policy entry
Retrieve a Policy entry identified by the <namespace>/<policyName> pair in the topic field
and the <label> in the path field.
Command
| Field |
Value |
| topic |
<namespace>/<policyName>/policies/commands/retrieve |
| path |
/entries/<label> |
Response
| Field |
|
Value |
| topic |
|
<namespace>/<policyName>/policies/commands/retrieve |
| path |
|
/entries/<label> |
| value |
|
The Policy entry as JSON object, see Policy representation (JSON). |
| status |
code |
|
| |
200 |
Success. |
Example: Retrieve a single Policy entry
Retrieve Policy subjects
Retrieve the subjects of the policy identified by the <namespace>/<policyName> pair in the topic field
and the <label> in the path field.
Command
| Field |
Value |
| topic |
<namespace>/<policyName>/policies/commands/retrieve |
| path |
/entries/<label>/subjects |
Response
| Field |
|
Value |
| topic |
|
<namespace>/<policyName>/policies/commands/retrieve |
| path |
|
/entries/<label>/subjects |
| value |
|
The subjects of the Policy as JSON object, see Policy representation (JSON). |
| status |
code |
|
| |
200 |
Success. |
Example: Retrieve all subjects
Retrieve a Policy subject
Retrieve specific subject of the policy identified by the <namespace>/<policyName> pair in the topic field
and the <label> and <subjectId> in the path field.
Command
| Field |
Value |
| topic |
<namespace>/<policyName>/policies/commands/retrieve |
| path |
/entries/<label>/subjects/<subjectId> |
Response
| Field |
|
Value |
| topic |
|
<namespace>/<policyName>/policies/commands/retrieve |
| path |
|
/entries/<label>/subjects/<subjectId> |
| value |
|
The subject of the policy as JSON object, see Policy representation (JSON). |
| status |
code |
|
| |
200 |
Success. |
Example: Retrieve a single subject
Retrieve Policy resources
Retrieve all resources of the policy identified by the <namespace>/<policyName> pair in the topic field
and the <label> in the path field.
Command
| Field |
Value |
| topic |
<namespace>/<policyName>/policies/commands/retrieve |
| path |
/entries/<label>/resources |
Response
| Field |
|
Value |
| topic |
|
<namespace>/<policyName>/policies/commands/retrieve |
| path |
|
/entries/<label>/resources |
| value |
|
The resources of the Policy as JSON object, see Policy representation (JSON). |
| status |
code |
|
| |
200 |
Success. |
Example: Retrieve all resources
Retrieve a single Policy resources
Retrieve a resource identified by the <namespace>/<policyName> pair in the topic field and the <label> and
<resource> in the pathfield.
Command
| Field |
Value |
| topic |
<namespace>/<policyName>/policies/commands/retrieve |
| path |
/entries/<label>/resources/<resource> |
Response
| Field |
|
Value |
| topic |
|
<namespace>/<policyName>/policies/commands/retrieve |
| path |
|
/entries/<label>/resources/<resource> |
| value |
|
The resource of the policy as JSON object, see Policy representation (JSON). |
| status |
code |
|
| |
200 |
Success. |
Example: Retrieve a single resource
Common errors
| status |
Value |
400 |
Bad Format - The request could not be completed due to malformed request syntax. |
401 |
Unauthorized - The request could not be completed due to missing authentication. |
403 |
Forbidden - The Policy could not be modified as the requester had insufficient permissions (‘WRITE’ is required). |
404 |
Not Found - The request could not be completed. The Policy with the given ID was not found in the context of the authenticated user. |
412 |
Precondition Failed - A precondition for reading or writing the (sub-)resource failed. This will happen for write requests, if you specified an If-Match or If-None-Match header, which fails the precondition check against the current ETag of the (sub-)resource. |
413 |
Request Entity Too Large - The created or modified entity is larger than the accepted limit of 100 kB. |
| |
See Policy Error Responses for examples of other error responses. |