Roles with what they grant and who holds them.

curl --request PATCH \
  --url https://app.assetinfinity.ai/api/role_settings \
  --header 'Content-Type: application/json' \
  --data '
{
  "code": "<string>",
  "description": "<string>",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "is_active": true,
  "is_external": true,
  "is_system": true,
  "name": "<string>",
  "own_assets_only": true,
  "permission_codes": "<string>",
  "permissions": 123,
  "row_version": 123,
  "users": 123,
  "work_order_edit_reach": "<string>",
  "work_order_reach": "<string>"
}
'

import requests

url = "https://app.assetinfinity.ai/api/role_settings"

payload = {
    "code": "<string>",
    "description": "<string>",
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "is_active": True,
    "is_external": True,
    "is_system": True,
    "name": "<string>",
    "own_assets_only": True,
    "permission_codes": "<string>",
    "permissions": 123,
    "row_version": 123,
    "users": 123,
    "work_order_edit_reach": "<string>",
    "work_order_reach": "<string>"
}
headers = {"Content-Type": "application/json"}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    code: '<string>',
    description: '<string>',
    id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    is_active: true,
    is_external: true,
    is_system: true,
    name: '<string>',
    own_assets_only: true,
    permission_codes: '<string>',
    permissions: 123,
    row_version: 123,
    users: 123,
    work_order_edit_reach: '<string>',
    work_order_reach: '<string>'
  })
};

fetch('https://app.assetinfinity.ai/api/role_settings', 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://app.assetinfinity.ai/api/role_settings",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'code' => '<string>',
    'description' => '<string>',
    'id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'is_active' => true,
    'is_external' => true,
    'is_system' => true,
    'name' => '<string>',
    'own_assets_only' => true,
    'permission_codes' => '<string>',
    'permissions' => 123,
    'row_version' => 123,
    'users' => 123,
    'work_order_edit_reach' => '<string>',
    'work_order_reach' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "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://app.assetinfinity.ai/api/role_settings"

	payload := strings.NewReader("{\n  \"code\": \"<string>\",\n  \"description\": \"<string>\",\n  \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"is_active\": true,\n  \"is_external\": true,\n  \"is_system\": true,\n  \"name\": \"<string>\",\n  \"own_assets_only\": true,\n  \"permission_codes\": \"<string>\",\n  \"permissions\": 123,\n  \"row_version\": 123,\n  \"users\": 123,\n  \"work_order_edit_reach\": \"<string>\",\n  \"work_order_reach\": \"<string>\"\n}")

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

	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.patch("https://app.assetinfinity.ai/api/role_settings")
  .header("Content-Type", "application/json")
  .body("{\n  \"code\": \"<string>\",\n  \"description\": \"<string>\",\n  \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"is_active\": true,\n  \"is_external\": true,\n  \"is_system\": true,\n  \"name\": \"<string>\",\n  \"own_assets_only\": true,\n  \"permission_codes\": \"<string>\",\n  \"permissions\": 123,\n  \"row_version\": 123,\n  \"users\": 123,\n  \"work_order_edit_reach\": \"<string>\",\n  \"work_order_reach\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.assetinfinity.ai/api/role_settings")

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

request = Net::HTTP::Patch.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"code\": \"<string>\",\n  \"description\": \"<string>\",\n  \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"is_active\": true,\n  \"is_external\": true,\n  \"is_system\": true,\n  \"name\": \"<string>\",\n  \"own_assets_only\": true,\n  \"permission_codes\": \"<string>\",\n  \"permissions\": 123,\n  \"row_version\": 123,\n  \"users\": 123,\n  \"work_order_edit_reach\": \"<string>\",\n  \"work_order_reach\": \"<string>\"\n}"

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

Access

Roles with what they grant and who holds them.

is_system marks the two roles the product maintains rather than the tenant: the administrator, which holds every permission and reaches every site, and the read-only role the product’s support team signs in with. Every other role is the tenant’s own to rename, change or delete.

is_external marks the ones that make their holder somebody another company employs — the second half of what identity.is_external() reads, and the reason granting one is not the same kind of act as granting any of the others.

PATCH

role_settings

curl --request PATCH \
  --url https://app.assetinfinity.ai/api/role_settings \
  --header 'Content-Type: application/json' \
  --data '
{
  "code": "<string>",
  "description": "<string>",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "is_active": true,
  "is_external": true,
  "is_system": true,
  "name": "<string>",
  "own_assets_only": true,
  "permission_codes": "<string>",
  "permissions": 123,
  "row_version": 123,
  "users": 123,
  "work_order_edit_reach": "<string>",
  "work_order_reach": "<string>"
}
'

import requests

url = "https://app.assetinfinity.ai/api/role_settings"

payload = {
    "code": "<string>",
    "description": "<string>",
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "is_active": True,
    "is_external": True,
    "is_system": True,
    "name": "<string>",
    "own_assets_only": True,
    "permission_codes": "<string>",
    "permissions": 123,
    "row_version": 123,
    "users": 123,
    "work_order_edit_reach": "<string>",
    "work_order_reach": "<string>"
}
headers = {"Content-Type": "application/json"}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    code: '<string>',
    description: '<string>',
    id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    is_active: true,
    is_external: true,
    is_system: true,
    name: '<string>',
    own_assets_only: true,
    permission_codes: '<string>',
    permissions: 123,
    row_version: 123,
    users: 123,
    work_order_edit_reach: '<string>',
    work_order_reach: '<string>'
  })
};

fetch('https://app.assetinfinity.ai/api/role_settings', 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://app.assetinfinity.ai/api/role_settings",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'code' => '<string>',
    'description' => '<string>',
    'id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'is_active' => true,
    'is_external' => true,
    'is_system' => true,
    'name' => '<string>',
    'own_assets_only' => true,
    'permission_codes' => '<string>',
    'permissions' => 123,
    'row_version' => 123,
    'users' => 123,
    'work_order_edit_reach' => '<string>',
    'work_order_reach' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "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://app.assetinfinity.ai/api/role_settings"

	payload := strings.NewReader("{\n  \"code\": \"<string>\",\n  \"description\": \"<string>\",\n  \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"is_active\": true,\n  \"is_external\": true,\n  \"is_system\": true,\n  \"name\": \"<string>\",\n  \"own_assets_only\": true,\n  \"permission_codes\": \"<string>\",\n  \"permissions\": 123,\n  \"row_version\": 123,\n  \"users\": 123,\n  \"work_order_edit_reach\": \"<string>\",\n  \"work_order_reach\": \"<string>\"\n}")

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

	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.patch("https://app.assetinfinity.ai/api/role_settings")
  .header("Content-Type", "application/json")
  .body("{\n  \"code\": \"<string>\",\n  \"description\": \"<string>\",\n  \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"is_active\": true,\n  \"is_external\": true,\n  \"is_system\": true,\n  \"name\": \"<string>\",\n  \"own_assets_only\": true,\n  \"permission_codes\": \"<string>\",\n  \"permissions\": 123,\n  \"row_version\": 123,\n  \"users\": 123,\n  \"work_order_edit_reach\": \"<string>\",\n  \"work_order_reach\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.assetinfinity.ai/api/role_settings")

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

request = Net::HTTP::Patch.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"code\": \"<string>\",\n  \"description\": \"<string>\",\n  \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"is_active\": true,\n  \"is_external\": true,\n  \"is_system\": true,\n  \"name\": \"<string>\",\n  \"own_assets_only\": true,\n  \"permission_codes\": \"<string>\",\n  \"permissions\": 123,\n  \"row_version\": 123,\n  \"users\": 123,\n  \"work_order_edit_reach\": \"<string>\",\n  \"work_order_reach\": \"<string>\"\n}"

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

Headers

Prefer

enum<string>

Preference

Available options:

return=representation,

return=minimal,

return=none

Query Parameters

string

code

string

name

string

description

string

is_system

string

is_external

string

own_assets_only

string

work_order_reach

string

work_order_edit_reach

string

is_active

string

permissions

string

users

string

permission_codes

string

row_version

string

Body

role_settings

Roles with what they grant and who holds them.

is_system marks the two roles the product maintains rather than the tenant: the administrator, which holds every permission and reaches every site, and the read-only role the product's support team signs in with. Every other role is the tenant's own to rename, change or delete.

code

string<character varying>

Maximum string length: 60

description

string<text>

string<uuid>

Note: This is a Primary Key.

is_active

boolean<boolean>

is_external

boolean<boolean>

is_system

boolean<boolean>

name

string<character varying>

Maximum string length: 150

own_assets_only

boolean<boolean>

permission_codes

string<jsonb>

permissions

integer<bigint>

row_version

integer<bigint>

users

integer<bigint>

work_order_edit_reach

string<character varying>

Maximum string length: 10

work_order_reach

string<character varying>

Maximum string length: 10

Response

204

No Content

Overview

Endpoints

Roles with what they grant and who holds them.

Headers

Query Parameters

Body

Response