Create RolePermission
curl --request POST \
--url https://platform.kodexa.ai/api/role-permissions \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"permissionId": "<string>",
"roleId": "<string>",
"permission": {
"action": "<string>",
"changeSequence": 123,
"createdOn": "2023-11-07T05:31:56Z",
"description": "<string>",
"id": "<string>",
"resource": "<string>",
"updatedOn": "2023-11-07T05:31:56Z",
"uuid": "<string>"
},
"role": {
"changeSequence": 123,
"createdOn": "2023-11-07T05:31:56Z",
"description": "<string>",
"displayName": "<string>",
"id": "<string>",
"name": "<string>",
"systemDefined": true,
"updatedOn": "2023-11-07T05:31:56Z",
"uuid": "<string>"
}
}
'import requests
url = "https://platform.kodexa.ai/api/role-permissions"
payload = {
"permissionId": "<string>",
"roleId": "<string>",
"permission": {
"action": "<string>",
"changeSequence": 123,
"createdOn": "2023-11-07T05:31:56Z",
"description": "<string>",
"id": "<string>",
"resource": "<string>",
"updatedOn": "2023-11-07T05:31:56Z",
"uuid": "<string>"
},
"role": {
"changeSequence": 123,
"createdOn": "2023-11-07T05:31:56Z",
"description": "<string>",
"displayName": "<string>",
"id": "<string>",
"name": "<string>",
"systemDefined": True,
"updatedOn": "2023-11-07T05:31:56Z",
"uuid": "<string>"
}
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
permissionId: '<string>',
roleId: '<string>',
permission: {
action: '<string>',
changeSequence: 123,
createdOn: '2023-11-07T05:31:56Z',
description: '<string>',
id: '<string>',
resource: '<string>',
updatedOn: '2023-11-07T05:31:56Z',
uuid: '<string>'
},
role: {
changeSequence: 123,
createdOn: '2023-11-07T05:31:56Z',
description: '<string>',
displayName: '<string>',
id: '<string>',
name: '<string>',
systemDefined: true,
updatedOn: '2023-11-07T05:31:56Z',
uuid: '<string>'
}
})
};
fetch('https://platform.kodexa.ai/api/role-permissions', 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://platform.kodexa.ai/api/role-permissions",
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([
'permissionId' => '<string>',
'roleId' => '<string>',
'permission' => [
'action' => '<string>',
'changeSequence' => 123,
'createdOn' => '2023-11-07T05:31:56Z',
'description' => '<string>',
'id' => '<string>',
'resource' => '<string>',
'updatedOn' => '2023-11-07T05:31:56Z',
'uuid' => '<string>'
],
'role' => [
'changeSequence' => 123,
'createdOn' => '2023-11-07T05:31:56Z',
'description' => '<string>',
'displayName' => '<string>',
'id' => '<string>',
'name' => '<string>',
'systemDefined' => true,
'updatedOn' => '2023-11-07T05:31:56Z',
'uuid' => '<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"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://platform.kodexa.ai/api/role-permissions"
payload := strings.NewReader("{\n \"permissionId\": \"<string>\",\n \"roleId\": \"<string>\",\n \"permission\": {\n \"action\": \"<string>\",\n \"changeSequence\": 123,\n \"createdOn\": \"2023-11-07T05:31:56Z\",\n \"description\": \"<string>\",\n \"id\": \"<string>\",\n \"resource\": \"<string>\",\n \"updatedOn\": \"2023-11-07T05:31:56Z\",\n \"uuid\": \"<string>\"\n },\n \"role\": {\n \"changeSequence\": 123,\n \"createdOn\": \"2023-11-07T05:31:56Z\",\n \"description\": \"<string>\",\n \"displayName\": \"<string>\",\n \"id\": \"<string>\",\n \"name\": \"<string>\",\n \"systemDefined\": true,\n \"updatedOn\": \"2023-11-07T05:31:56Z\",\n \"uuid\": \"<string>\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
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://platform.kodexa.ai/api/role-permissions")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"permissionId\": \"<string>\",\n \"roleId\": \"<string>\",\n \"permission\": {\n \"action\": \"<string>\",\n \"changeSequence\": 123,\n \"createdOn\": \"2023-11-07T05:31:56Z\",\n \"description\": \"<string>\",\n \"id\": \"<string>\",\n \"resource\": \"<string>\",\n \"updatedOn\": \"2023-11-07T05:31:56Z\",\n \"uuid\": \"<string>\"\n },\n \"role\": {\n \"changeSequence\": 123,\n \"createdOn\": \"2023-11-07T05:31:56Z\",\n \"description\": \"<string>\",\n \"displayName\": \"<string>\",\n \"id\": \"<string>\",\n \"name\": \"<string>\",\n \"systemDefined\": true,\n \"updatedOn\": \"2023-11-07T05:31:56Z\",\n \"uuid\": \"<string>\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://platform.kodexa.ai/api/role-permissions")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"permissionId\": \"<string>\",\n \"roleId\": \"<string>\",\n \"permission\": {\n \"action\": \"<string>\",\n \"changeSequence\": 123,\n \"createdOn\": \"2023-11-07T05:31:56Z\",\n \"description\": \"<string>\",\n \"id\": \"<string>\",\n \"resource\": \"<string>\",\n \"updatedOn\": \"2023-11-07T05:31:56Z\",\n \"uuid\": \"<string>\"\n },\n \"role\": {\n \"changeSequence\": 123,\n \"createdOn\": \"2023-11-07T05:31:56Z\",\n \"description\": \"<string>\",\n \"displayName\": \"<string>\",\n \"id\": \"<string>\",\n \"name\": \"<string>\",\n \"systemDefined\": true,\n \"updatedOn\": \"2023-11-07T05:31:56Z\",\n \"uuid\": \"<string>\"\n }\n}"
response = http.request(request)
puts response.read_body{
"changeSequence": 123,
"createdOn": "2023-11-07T05:31:56Z",
"id": "<string>",
"permissionId": "<string>",
"roleId": "<string>",
"updatedOn": "2023-11-07T05:31:56Z",
"uuid": "<string>",
"permission": {
"action": "<string>",
"changeSequence": 123,
"createdOn": "2023-11-07T05:31:56Z",
"description": "<string>",
"id": "<string>",
"resource": "<string>",
"updatedOn": "2023-11-07T05:31:56Z",
"uuid": "<string>"
},
"role": {
"changeSequence": 123,
"createdOn": "2023-11-07T05:31:56Z",
"description": "<string>",
"displayName": "<string>",
"id": "<string>",
"name": "<string>",
"systemDefined": true,
"updatedOn": "2023-11-07T05:31:56Z",
"uuid": "<string>"
}
}Role Permissions
Create RolePermission
Creates a new RolePermission. Role permissions link roles to their granted permissions.
POST
/
api
/
role-permissions
Create RolePermission
curl --request POST \
--url https://platform.kodexa.ai/api/role-permissions \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"permissionId": "<string>",
"roleId": "<string>",
"permission": {
"action": "<string>",
"changeSequence": 123,
"createdOn": "2023-11-07T05:31:56Z",
"description": "<string>",
"id": "<string>",
"resource": "<string>",
"updatedOn": "2023-11-07T05:31:56Z",
"uuid": "<string>"
},
"role": {
"changeSequence": 123,
"createdOn": "2023-11-07T05:31:56Z",
"description": "<string>",
"displayName": "<string>",
"id": "<string>",
"name": "<string>",
"systemDefined": true,
"updatedOn": "2023-11-07T05:31:56Z",
"uuid": "<string>"
}
}
'import requests
url = "https://platform.kodexa.ai/api/role-permissions"
payload = {
"permissionId": "<string>",
"roleId": "<string>",
"permission": {
"action": "<string>",
"changeSequence": 123,
"createdOn": "2023-11-07T05:31:56Z",
"description": "<string>",
"id": "<string>",
"resource": "<string>",
"updatedOn": "2023-11-07T05:31:56Z",
"uuid": "<string>"
},
"role": {
"changeSequence": 123,
"createdOn": "2023-11-07T05:31:56Z",
"description": "<string>",
"displayName": "<string>",
"id": "<string>",
"name": "<string>",
"systemDefined": True,
"updatedOn": "2023-11-07T05:31:56Z",
"uuid": "<string>"
}
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
permissionId: '<string>',
roleId: '<string>',
permission: {
action: '<string>',
changeSequence: 123,
createdOn: '2023-11-07T05:31:56Z',
description: '<string>',
id: '<string>',
resource: '<string>',
updatedOn: '2023-11-07T05:31:56Z',
uuid: '<string>'
},
role: {
changeSequence: 123,
createdOn: '2023-11-07T05:31:56Z',
description: '<string>',
displayName: '<string>',
id: '<string>',
name: '<string>',
systemDefined: true,
updatedOn: '2023-11-07T05:31:56Z',
uuid: '<string>'
}
})
};
fetch('https://platform.kodexa.ai/api/role-permissions', 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://platform.kodexa.ai/api/role-permissions",
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([
'permissionId' => '<string>',
'roleId' => '<string>',
'permission' => [
'action' => '<string>',
'changeSequence' => 123,
'createdOn' => '2023-11-07T05:31:56Z',
'description' => '<string>',
'id' => '<string>',
'resource' => '<string>',
'updatedOn' => '2023-11-07T05:31:56Z',
'uuid' => '<string>'
],
'role' => [
'changeSequence' => 123,
'createdOn' => '2023-11-07T05:31:56Z',
'description' => '<string>',
'displayName' => '<string>',
'id' => '<string>',
'name' => '<string>',
'systemDefined' => true,
'updatedOn' => '2023-11-07T05:31:56Z',
'uuid' => '<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"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://platform.kodexa.ai/api/role-permissions"
payload := strings.NewReader("{\n \"permissionId\": \"<string>\",\n \"roleId\": \"<string>\",\n \"permission\": {\n \"action\": \"<string>\",\n \"changeSequence\": 123,\n \"createdOn\": \"2023-11-07T05:31:56Z\",\n \"description\": \"<string>\",\n \"id\": \"<string>\",\n \"resource\": \"<string>\",\n \"updatedOn\": \"2023-11-07T05:31:56Z\",\n \"uuid\": \"<string>\"\n },\n \"role\": {\n \"changeSequence\": 123,\n \"createdOn\": \"2023-11-07T05:31:56Z\",\n \"description\": \"<string>\",\n \"displayName\": \"<string>\",\n \"id\": \"<string>\",\n \"name\": \"<string>\",\n \"systemDefined\": true,\n \"updatedOn\": \"2023-11-07T05:31:56Z\",\n \"uuid\": \"<string>\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
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://platform.kodexa.ai/api/role-permissions")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"permissionId\": \"<string>\",\n \"roleId\": \"<string>\",\n \"permission\": {\n \"action\": \"<string>\",\n \"changeSequence\": 123,\n \"createdOn\": \"2023-11-07T05:31:56Z\",\n \"description\": \"<string>\",\n \"id\": \"<string>\",\n \"resource\": \"<string>\",\n \"updatedOn\": \"2023-11-07T05:31:56Z\",\n \"uuid\": \"<string>\"\n },\n \"role\": {\n \"changeSequence\": 123,\n \"createdOn\": \"2023-11-07T05:31:56Z\",\n \"description\": \"<string>\",\n \"displayName\": \"<string>\",\n \"id\": \"<string>\",\n \"name\": \"<string>\",\n \"systemDefined\": true,\n \"updatedOn\": \"2023-11-07T05:31:56Z\",\n \"uuid\": \"<string>\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://platform.kodexa.ai/api/role-permissions")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"permissionId\": \"<string>\",\n \"roleId\": \"<string>\",\n \"permission\": {\n \"action\": \"<string>\",\n \"changeSequence\": 123,\n \"createdOn\": \"2023-11-07T05:31:56Z\",\n \"description\": \"<string>\",\n \"id\": \"<string>\",\n \"resource\": \"<string>\",\n \"updatedOn\": \"2023-11-07T05:31:56Z\",\n \"uuid\": \"<string>\"\n },\n \"role\": {\n \"changeSequence\": 123,\n \"createdOn\": \"2023-11-07T05:31:56Z\",\n \"description\": \"<string>\",\n \"displayName\": \"<string>\",\n \"id\": \"<string>\",\n \"name\": \"<string>\",\n \"systemDefined\": true,\n \"updatedOn\": \"2023-11-07T05:31:56Z\",\n \"uuid\": \"<string>\"\n }\n}"
response = http.request(request)
puts response.read_body{
"changeSequence": 123,
"createdOn": "2023-11-07T05:31:56Z",
"id": "<string>",
"permissionId": "<string>",
"roleId": "<string>",
"updatedOn": "2023-11-07T05:31:56Z",
"uuid": "<string>",
"permission": {
"action": "<string>",
"changeSequence": 123,
"createdOn": "2023-11-07T05:31:56Z",
"description": "<string>",
"id": "<string>",
"resource": "<string>",
"updatedOn": "2023-11-07T05:31:56Z",
"uuid": "<string>"
},
"role": {
"changeSequence": 123,
"createdOn": "2023-11-07T05:31:56Z",
"description": "<string>",
"displayName": "<string>",
"id": "<string>",
"name": "<string>",
"systemDefined": true,
"updatedOn": "2023-11-07T05:31:56Z",
"uuid": "<string>"
}
}Authorizations
x-api-keybearerAuth
API key for authentication. Create one from the Kodexa platform UI under Settings > Access Tokens.
Body
application/json
Response
Created RolePermission