SMsmokeball
Authorization

Update an authorization policy

Updates a specified authorization policy.

put/policies/{reference}

Request

  • Base URL
    https://api.smokeball.com
  • URL
    https://api.smokeball.com/policies/{reference}
  • Auth
    API key in header x-api-key and API key in header Authorization

Path parameters

referencestring required

Request body

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 request

{
  "principalId": "a7922e80-f833-48f0-8250-c00df1ebbc16",
  "resourceId": "matters/54171794-5ca3-472b-889a-c03538d8c89a",
  "rules": [
    {
      "principalId": "a7922e80-f833-48f0-8250-c00df1ebbc16",
      "resourceId": "matters/69406c65-309d-4e35-a636-ad145e64770a",
      "operation": "Access"
    }
  ]
}

Response

When request is accepted. Returns a hypermedia 'Link' object of the authorization policy to be updated.

idstring nullable
hrefstring nullable
relationstring nullable
methodstring nullable

Changes

No recorded changes to this operation across all 15 revisions of this API.