Update Permission Policy - m3ter Documentation

Update Permission Policy

cURL

curl --request PUT \
  --url https://api.m3ter.com/organizations/{orgId}/permissionpolicies/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "permissionPolicy": [
    {
      "action": [],
      "resource": [
        "<string>"
      ]
    }
  ],
  "version": 123
}
'```

### Python Example

```python
import requests

url = "https://api.m3ter.com/organizations/{orgId}/permissionpolicies/{id}"

payload = {
    "name": "<string>",
    "permissionPolicy": [
        {
            "action": [],
            "resource": ["<string>"]
        }
    ],
    "version": 123
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

JavaScript Example (Fetch)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    permissionPolicy: [{action: [], resource: ['<string>']}],
    version: 123
  })
};

fetch('https://api.m3ter.com/organizations/{orgId}/permissionpolicies/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

PHP Example

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.m3ter.com/organizations/{orgId}/permissionpolicies/{id}",
  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([
    'name' => '<string>',
    'permissionPolicy' => [
        [
                'action' => [],
                'resource' => ['<string>']
        ]
    ],
    'version' => 123
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

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

curl_close($curl);

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

Go Example

package main

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

func main() {

url := "https://api.m3ter.com/organizations/{orgId}/permissionpolicies/{id}"

payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"permissionPolicy\": [\n    {\n      \"action\": [],\n      \"resource\": [\n        \"<string>\"\n      ]\n    }\n  ],\n  \"version\": 123\n}")

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

req.Header.Add("Authorization", "Bearer <token>")
    req.Header.Add("Content-Type", "application/json")

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

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

fmt.Println(string(body))
}

Unirest Example

HttpResponse<String> response = Unirest.put("https://api.m3ter.com/organizations/{orgId}/permissionpolicies/{id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"permissionPolicy\": [\n    {\n      \"action\": [],\n      \"resource\": [\n        \"<string>\"\n      ]\n    }\n  ],\n  \"version\": 123\n}")
  .asString();

Ruby Example

require 'uri'
require 'net/http'

url = URI("https://api.m3ter.com/organizations/{orgId}/permissionpolicies/{id}")

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

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"permissionPolicy\": [\n    {\n      \"action\": [],\n      \"resource\": [\n        \"<string>\"\n      ]\n    }\n  ],\n  \"version\": 123\n}"

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

Response Codes

Success Response (200)

Response when the Permission Policy is successfully updated.

{
  "id": "<string>",
  "version": 123,
  "name": "<string>",
  "permissionPolicy": [
    {
      "action": [],
      "resource": [
        "<string>"
      ]
    }
  ],
  "managedPolicy": true,
  "dtCreated": "2023-11-07T05:31:56Z",
  "dtLastModified": "2023-11-07T05:31:56Z",
  "createdBy": "<string>",
  "lastModifiedBy": "<string>"
}

Error Responses

4XX

{
  "message": "<string>"
}

5XX

{
  "message": "<string>"
}

Authorization

• m3ter supports machine-to-machine authentication using the clientCredentials OAuth2 flow.
• The authorizationCode flow controls access for human users via the m3ter Console application.

Path Parameters

• id: Required UUID of the PermissionPolicy to update.
• orgId: Required UUID of the organization.

Body Parameters

application/json

• name: Required string length: 1 - 100.
• permissionPolicy: Required minimum array length: 1.
• version: Integer, required for updates.