Add a PermissionPolicy to a service user

curl --request POST \
  --url https://api.m3ter.com/organizations/{orgId}/permissionpolicies/{permissionPolicyId}/addtoserviceuser \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "principalId": "<string>",
  "version": 123
}
'

import requests

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

payload = {
    "principalId": "<string>",
    "version": 123
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({principalId: '<string>', version: 123})
};

fetch('https://api.m3ter.com/organizations/{orgId}/permissionpolicies/{permissionPolicyId}/addtoserviceuser', 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.m3ter.com/organizations/{orgId}/permissionpolicies/{permissionPolicyId}/addtoserviceuser",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'principalId' => '<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;
}

package main

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

func main() {

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

	payload := strings.NewReader("{\n  \"principalId\": \"<string>\",\n  \"version\": 123\n}")

	req, _ := http.NewRequest("POST", 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))

}

HttpResponse<String> response = Unirest.post("https://api.m3ter.com/organizations/{orgId}/permissionpolicies/{permissionPolicyId}/addtoserviceuser")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"principalId\": \"<string>\",\n  \"version\": 123\n}")
  .asString();

require 'uri'
require 'net/http'

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

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

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

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

{
  "id": "<string>",
  "version": 123,
  "permissionPolicyId": "<string>",
  "principalId": "<string>",
  "principalType": "USER",
  "dtCreated": "2023-11-07T05:31:56Z",
  "dtLastModified": "2023-11-07T05:31:56Z",
  "createdBy": "<string>",
  "lastModifiedBy": "<string>"
}

{
  "message": "<string>"
}

{
  "message": "<string>"
}

POST

organizations

{orgId}

permissionpolicies

{permissionPolicyId}

addtoserviceuser

Add a PermissionPolicy to a service user

curl --request POST \
  --url https://api.m3ter.com/organizations/{orgId}/permissionpolicies/{permissionPolicyId}/addtoserviceuser \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "principalId": "<string>",
  "version": 123
}
'

import requests

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

payload = {
    "principalId": "<string>",
    "version": 123
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({principalId: '<string>', version: 123})
};

fetch('https://api.m3ter.com/organizations/{orgId}/permissionpolicies/{permissionPolicyId}/addtoserviceuser', 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.m3ter.com/organizations/{orgId}/permissionpolicies/{permissionPolicyId}/addtoserviceuser",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'principalId' => '<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;
}

package main

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

func main() {

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

	payload := strings.NewReader("{\n  \"principalId\": \"<string>\",\n  \"version\": 123\n}")

	req, _ := http.NewRequest("POST", 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))

}

HttpResponse<String> response = Unirest.post("https://api.m3ter.com/organizations/{orgId}/permissionpolicies/{permissionPolicyId}/addtoserviceuser")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"principalId\": \"<string>\",\n  \"version\": 123\n}")
  .asString();

require 'uri'
require 'net/http'

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

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

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

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

{
  "id": "<string>",
  "version": 123,
  "permissionPolicyId": "<string>",
  "principalId": "<string>",
  "principalType": "USER",
  "dtCreated": "2023-11-07T05:31:56Z",
  "dtLastModified": "2023-11-07T05:31:56Z",
  "createdBy": "<string>",
  "lastModifiedBy": "<string>"
}

{
  "message": "<string>"
}

{
  "message": "<string>"
}

Authorizations

Authorization

string

header

required

m3ter supports machine to machine authentication using the clientCredentials OAuth2 flow.

The authorizationCode flow controls access for human users via the m3ter Console application.

FlowAuthorization Code

Authorization URL: https://m3ter.auth.us-east-1.amazoncognito.com/oauth2/authorize
Token URL: https://m3ter.auth.us-east-1.amazoncognito.com/oauth2/token

FlowClient Credentials

Token URL: /oauth/token

Path Parameters

orgId

string

required

UUID of the organization

permissionPolicyId

string

required

UUID of the permission policy

Body

application/json

principalId

string

required

Minimum string length: 1

version

integer<int64>

The version number of the entity:

Create entity: Not valid for initial insertion of new entity - do not use for Create. On initial Create, version is set at 1 and listed in the response.
Update Entity: On Update, version is required and must match the existing version because a check is performed to ensure sequential versioning is preserved. Version is incremented by 1 and listed in the response.

Response

Returns the PrincipalPermission

string

required

The UUID of the entity.

version

integer<int64>

The version number:

Create: On initial Create to insert a new entity, the version is set at 1 in the response.
Update: On successful Update, the version is incremented by 1 in the response.

permissionPolicyId

string

principalId

string

principalType

enum<string>

Available options:

USER,

USERGROUP,

SERVICEUSER,

SUPPORTUSERS

dtCreated

string<date-time>

The DateTime (in ISO-8601 format) when the principal permission was created.

dtLastModified

string<date-time>

The DateTime (in ISO-8601 format) when the principal permission was last modified.

createdBy

string

The id of the user who created this principal permission.

lastModifiedBy

string

The id of the user who last modified this principal permission.

Getting Started

Endpoints

Add a PermissionPolicy to a service user

Authorizations

Path Parameters

Body

Response