GET
/
policies
/
{reference}
Get an authorization policy
curl --request GET \
  --url https://api.smokeball.com/policies/{reference} \
  --header 'Authorization: <api-key>' \
  --header 'x-api-key: <api-key>'
{
  "href": "<string>",
  "relation": "<string>",
  "method": "GET",
  "self": {
    "id": "<string>",
    "href": "<string>",
    "relation": "<string>",
    "method": "GET"
  },
  "id": "eb40ac02-383c-49bd-b956-c02cba814215",
  "reference": "31a9caa9-4db7-4a0e-8233-d51254975099",
  "principalId": "a7922e80-f833-48f0-8250-c00df1ebbc16",
  "resourceId": "54171794-5ca3-472b-889a-c03538d8c89a",
  "rules": [
    {
      "principalId": "a7922e80-f833-48f0-8250-c00df1ebbc16",
      "resourceId": "matters/69406c65-309d-4e35-a636-ad145e64770a",
      "operation": "Access",
      "type": 0
    }
  ]
}

Authorizations

​
x-api-key
string
header
required
​
Authorization
string
header
required

Path Parameters

​
reference
string
required

Response

When request is successful. Returns an authorization 'Policy' object.

​
href
string | null
​
relation
string | null
​
method
string | null
default:GET
​
self
object
​
id
string | null

Unique id of the policy.

Example:

"eb40ac02-383c-49bd-b956-c02cba814215"

​
reference
string | null

Unique reference of the policy.

Example:

"31a9caa9-4db7-4a0e-8233-d51254975099"

​
principalId
string | null

Principal id associated to this policy if it is a principal based policy. This can be either a user id or a group id.

This is null if the policy is a resource based policy.

Example:

"a7922e80-f833-48f0-8250-c00df1ebbc16"

​
resourceId
string | null

Resource id associated to this policy if it is a resource based policy.

This is null if the policy is a principal based policy.

Example:

"54171794-5ca3-472b-889a-c03538d8c89a"

​
rules
object[] | null

The rules associated to this policy.