v2

latestOpenAPI 3.0.12026-07-262352981007.0 KB

Authorization

Get an authorization policy

Retrieves a specified authorization policy.

get/policies/{reference}

Path parameters

referencestring required

Response

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

hrefstring nullable

relationstring nullable

methodstring nullable

idstring nullable

Unique id of the policy.

referencestring nullable

Unique reference of the policy.

principalIdstring nullable

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.

resourceIdstring nullable

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 response

{
  "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"
    }
  ]
}