add permissions.

curl --request PUT \
  --url https://apix.us.amity.co/api/v2/roles \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: <content-type>' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "publicIds": [
    "<string>"
  ],
  "permissions": [
    "<string>"
  ]
}
'

import requests

url = "https://apix.us.amity.co/api/v2/roles"

payload = {
    "publicIds": ["<string>"],
    "permissions": ["<string>"]
}
headers = {
    "Authorization": "<authorization>",
    "Content-Type": "<content-type>",
    "X-API-Key": "<api-key>"
}

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

print(response.text)

const options = {
  method: 'PUT',
  headers: {
    Authorization: '<authorization>',
    'Content-Type': '<content-type>',
    'X-API-Key': '<api-key>'
  },
  body: JSON.stringify({publicIds: ['<string>'], permissions: ['<string>']})
};

fetch('https://apix.us.amity.co/api/v2/roles', 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://apix.us.amity.co/api/v2/roles",
  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([
    'publicIds' => [
        '<string>'
    ],
    'permissions' => [
        '<string>'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <authorization>",
    "Content-Type: <content-type>",
    "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://apix.us.amity.co/api/v2/roles"

	payload := strings.NewReader("{\n  \"publicIds\": [\n    \"<string>\"\n  ],\n  \"permissions\": [\n    \"<string>\"\n  ]\n}")

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

	req.Header.Add("Authorization", "<authorization>")
	req.Header.Add("Content-Type", "<content-type>")
	req.Header.Add("X-API-Key", "<api-key>")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.put("https://apix.us.amity.co/api/v2/roles")
  .header("Authorization", "<authorization>")
  .header("Content-Type", "<content-type>")
  .header("X-API-Key", "<api-key>")
  .body("{\n  \"publicIds\": [\n    \"<string>\"\n  ],\n  \"permissions\": [\n    \"<string>\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://apix.us.amity.co/api/v2/roles")

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

request = Net::HTTP::Put.new(url)
request["Authorization"] = '<authorization>'
request["Content-Type"] = '<content-type>'
request["X-API-Key"] = '<api-key>'
request.body = "{\n  \"publicIds\": [\n    \"<string>\"\n  ],\n  \"permissions\": [\n    \"<string>\"\n  ]\n}"

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

{
  "status": "error",
  "code": 404,
  "message": "Resource Not Found."
}

{
  "status": "error",
  "code": 429,
  "message": "RateLimit Exceed."
}

{
  "status": "error",
  "code": 500,
  "message": "Unexpected error"
}

PUT

api

roles

add permissions.

curl --request PUT \
  --url https://apix.us.amity.co/api/v2/roles \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: <content-type>' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "publicIds": [
    "<string>"
  ],
  "permissions": [
    "<string>"
  ]
}
'

import requests

url = "https://apix.us.amity.co/api/v2/roles"

payload = {
    "publicIds": ["<string>"],
    "permissions": ["<string>"]
}
headers = {
    "Authorization": "<authorization>",
    "Content-Type": "<content-type>",
    "X-API-Key": "<api-key>"
}

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

print(response.text)

const options = {
  method: 'PUT',
  headers: {
    Authorization: '<authorization>',
    'Content-Type': '<content-type>',
    'X-API-Key': '<api-key>'
  },
  body: JSON.stringify({publicIds: ['<string>'], permissions: ['<string>']})
};

fetch('https://apix.us.amity.co/api/v2/roles', 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://apix.us.amity.co/api/v2/roles",
  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([
    'publicIds' => [
        '<string>'
    ],
    'permissions' => [
        '<string>'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <authorization>",
    "Content-Type: <content-type>",
    "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://apix.us.amity.co/api/v2/roles"

	payload := strings.NewReader("{\n  \"publicIds\": [\n    \"<string>\"\n  ],\n  \"permissions\": [\n    \"<string>\"\n  ]\n}")

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

	req.Header.Add("Authorization", "<authorization>")
	req.Header.Add("Content-Type", "<content-type>")
	req.Header.Add("X-API-Key", "<api-key>")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.put("https://apix.us.amity.co/api/v2/roles")
  .header("Authorization", "<authorization>")
  .header("Content-Type", "<content-type>")
  .header("X-API-Key", "<api-key>")
  .body("{\n  \"publicIds\": [\n    \"<string>\"\n  ],\n  \"permissions\": [\n    \"<string>\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://apix.us.amity.co/api/v2/roles")

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

request = Net::HTTP::Put.new(url)
request["Authorization"] = '<authorization>'
request["Content-Type"] = '<content-type>'
request["X-API-Key"] = '<api-key>'
request.body = "{\n  \"publicIds\": [\n    \"<string>\"\n  ],\n  \"permissions\": [\n    \"<string>\"\n  ]\n}"

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

{
  "status": "error",
  "code": 404,
  "message": "Resource Not Found."
}

{
  "status": "error",
  "code": 429,
  "message": "RateLimit Exceed."
}

{
  "status": "error",
  "code": 500,
  "message": "Unexpected error"
}

Authorizations

X-API-Key

string

header

required

Headers

Authorization

string

required

Content-Type

string

required

Body

application/json

Permission information to be added

publicIds

string[]

required

The list of role public ids

permissions

string[]

required

The list of permission to be added. You can see all permissions at https://docs.amity.co/amity-sdk/core-concepts/user/user-permission#permissions

Response

get all roles Get roles (pagination support)

⌘I