Get an authorization policy

Retrieves a specified authorization policy.

GET /policies/{reference}

Get an authorization policy

cURL

curl --request GET \
  --url https://api.smokeball.com/policies/{reference} \
  --header 'Authorization: <api-key>' \
  --header 'x-api-key: <api-key>'

import requests

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

headers = {
    "x-api-key": "<api-key>",
    "Authorization": "<api-key>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'x-api-key': '<api-key>', Authorization: '<api-key>'}};

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 => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "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"
	"net/http"
	"io"
)

func main() {

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

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<api-key>")
	req.Header.Add("Authorization", "<api-key>")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.smokeball.com/policies/{reference}")
  .header("x-api-key", "<api-key>")
  .header("Authorization", "<api-key>")
  .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::Get.new(url)
request["x-api-key"] = '<api-key>'
request["Authorization"] = '<api-key>'

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

200

{
  "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": "<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

Response

200

application/json

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

href · string | null

relation · string | null

method · string | null · default: GET

self · object | null

Show child attributes

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.

Show child attributes