Update an authorization policy

Updates a specified authorization policy.

PUT /policies/{reference}

Update an authorization policy

cURL

curl --request PUT \
  --url https://api.smokeball.com/policies/{reference} \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json-patch+json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "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"
    }
  ]
}
'

import requests

url = "https://api.smokeball.com/policies/{reference}"

payload = {
    "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"
        }
    ]
}
headers = {
    "x-api-key": "<api-key>",
    "Authorization": "<api-key>",
    "Content-Type": "application/json-patch+json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {
    'x-api-key': '<api-key>',
    Authorization: '<api-key>',
    'Content-Type': 'application/json-patch+json'
  },
  body: JSON.stringify({
    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'
      }
    ]
  })
};

fetch('https://api.smokeball.com/policies/{reference}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.smokeball.com/policies/{reference}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    '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'
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "Content-Type: application/json-patch+json",
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.smokeball.com/policies/{reference}"

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

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("x-api-key", "<api-key>")
	req.Header.Add("Authorization", "<api-key>")
	req.Header.Add("Content-Type", "application/json-patch+json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.put("https://api.smokeball.com/policies/{reference}")
  .header("x-api-key", "<api-key>")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json-patch+json")
  .body("{\n  \"principalId\": \"a7922e80-f833-48f0-8250-c00df1ebbc16\",\n  \"resourceId\": \"matters/54171794-5ca3-472b-889a-c03538d8c89a\",\n  \"rules\": [\n    {\n      \"principalId\": \"a7922e80-f833-48f0-8250-c00df1ebbc16\",\n      \"resourceId\": \"matters/69406c65-309d-4e35-a636-ad145e64770a\",\n      \"operation\": \"Access\"\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.smokeball.com/policies/{reference}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["x-api-key"] = '<api-key>'
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json-patch+json'
request.body = "{\n  \"principalId\": \"a7922e80-f833-48f0-8250-c00df1ebbc16\",\n  \"resourceId\": \"matters/54171794-5ca3-472b-889a-c03538d8c89a\",\n  \"rules\": [\n    {\n      \"principalId\": \"a7922e80-f833-48f0-8250-c00df1ebbc16\",\n      \"resourceId\": \"matters/69406c65-309d-4e35-a636-ad145e64770a\",\n      \"operation\": \"Access\"\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body

202

{
  "id": "<string>",
  "href": "<string>",
  "relation": "<string>",
  "method": "GET"
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "instance": "<string>"
}

Authorizations

x-api-key · string · header · required

Authorization · string · header · required

Path Parameters

reference · string · required

Body

application/json-patch+jsonapplication/jsonapplication/*+json

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:

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

rules · object[] | null

The rules associated to this policy.

Show child attributes

Response

202

application/json

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

id · string | null

href · string | null

relation · string | null

method · string | null · default: GET