Create role - Cargo | GTM Infrastructure for AI Agents

Create role

curl --request POST \
  --url https://api.getcargo.io/v1/workspaceManagement/roles \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "slug": "<string>",
  "permissions": [
    {
      "resources": [
        "<string>"
      ],
      "actions": []
    }
  ],
  "description": "<string>"
}
'

import requests

url = "https://api.getcargo.io/v1/workspaceManagement/roles"

payload = {
    "name": "<string>",
    "slug": "<string>",
    "permissions": [
        {
            "resources": ["<string>"],
            "actions": []
        }
    ],
    "description": "<string>"
}
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({
    name: '<string>',
    slug: '<string>',
    permissions: [{resources: ['<string>'], actions: []}],
    description: '<string>'
  })
};

fetch('https://api.getcargo.io/v1/workspaceManagement/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://api.getcargo.io/v1/workspaceManagement/roles",
  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([
    'name' => '<string>',
    'slug' => '<string>',
    'permissions' => [
        [
                'resources' => [
                                '<string>'
                ],
                'actions' => [
                                
                ]
        ]
    ],
    'description' => '<string>'
  ]),
  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.getcargo.io/v1/workspaceManagement/roles"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"slug\": \"<string>\",\n  \"permissions\": [\n    {\n      \"resources\": [\n        \"<string>\"\n      ],\n      \"actions\": []\n    }\n  ],\n  \"description\": \"<string>\"\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.getcargo.io/v1/workspaceManagement/roles")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"slug\": \"<string>\",\n  \"permissions\": [\n    {\n      \"resources\": [\n        \"<string>\"\n      ],\n      \"actions\": []\n    }\n  ],\n  \"description\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.getcargo.io/v1/workspaceManagement/roles")

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  \"name\": \"<string>\",\n  \"slug\": \"<string>\",\n  \"permissions\": [\n    {\n      \"resources\": [\n        \"<string>\"\n      ],\n      \"actions\": []\n    }\n  ],\n  \"description\": \"<string>\"\n}"

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

{
  "role": {
    "uuid": "<string>",
    "name": "<string>",
    "slug": "<string>",
    "color": "orange",
    "description": "<string>",
    "permissions": [
      {
        "effect": "allow",
        "resources": [
          "<string>"
        ],
        "actions": [
          "ai:*"
        ]
      }
    ],
    "workspaceUuid": "<string>",
    "createdAt": "<string>",
    "updatedAt": "<string>",
    "deletedAt": "<string>"
  }
}

{
  "errorMessage": "<string>",
  "reason": "<string>"
}

{
  "errorMessage": "<string>",
  "reason": "<string>"
}

{
  "errorMessage": "<string>",
  "reason": "<string>"
}

{
  "errorMessage": "<string>",
  "reason": "<string>"
}

{
  "errorMessage": "<string>",
  "reason": "<string>"
}

{
  "errorMessage": "<string>",
  "reason": "<string>"
}

{
  "errorMessage": "<string>",
  "reason": "<string>"
}

POST

workspaceManagement

roles

Create role

curl --request POST \
  --url https://api.getcargo.io/v1/workspaceManagement/roles \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "slug": "<string>",
  "permissions": [
    {
      "resources": [
        "<string>"
      ],
      "actions": []
    }
  ],
  "description": "<string>"
}
'

import requests

url = "https://api.getcargo.io/v1/workspaceManagement/roles"

payload = {
    "name": "<string>",
    "slug": "<string>",
    "permissions": [
        {
            "resources": ["<string>"],
            "actions": []
        }
    ],
    "description": "<string>"
}
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({
    name: '<string>',
    slug: '<string>',
    permissions: [{resources: ['<string>'], actions: []}],
    description: '<string>'
  })
};

fetch('https://api.getcargo.io/v1/workspaceManagement/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://api.getcargo.io/v1/workspaceManagement/roles",
  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([
    'name' => '<string>',
    'slug' => '<string>',
    'permissions' => [
        [
                'resources' => [
                                '<string>'
                ],
                'actions' => [
                                
                ]
        ]
    ],
    'description' => '<string>'
  ]),
  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.getcargo.io/v1/workspaceManagement/roles"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"slug\": \"<string>\",\n  \"permissions\": [\n    {\n      \"resources\": [\n        \"<string>\"\n      ],\n      \"actions\": []\n    }\n  ],\n  \"description\": \"<string>\"\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.getcargo.io/v1/workspaceManagement/roles")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"slug\": \"<string>\",\n  \"permissions\": [\n    {\n      \"resources\": [\n        \"<string>\"\n      ],\n      \"actions\": []\n    }\n  ],\n  \"description\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.getcargo.io/v1/workspaceManagement/roles")

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  \"name\": \"<string>\",\n  \"slug\": \"<string>\",\n  \"permissions\": [\n    {\n      \"resources\": [\n        \"<string>\"\n      ],\n      \"actions\": []\n    }\n  ],\n  \"description\": \"<string>\"\n}"

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

{
  "role": {
    "uuid": "<string>",
    "name": "<string>",
    "slug": "<string>",
    "color": "orange",
    "description": "<string>",
    "permissions": [
      {
        "effect": "allow",
        "resources": [
          "<string>"
        ],
        "actions": [
          "ai:*"
        ]
      }
    ],
    "workspaceUuid": "<string>",
    "createdAt": "<string>",
    "updatedAt": "<string>",
    "deletedAt": "<string>"
  }
}

{
  "errorMessage": "<string>",
  "reason": "<string>"
}

{
  "errorMessage": "<string>",
  "reason": "<string>"
}

{
  "errorMessage": "<string>",
  "reason": "<string>"
}

{
  "errorMessage": "<string>",
  "reason": "<string>"
}

{
  "errorMessage": "<string>",
  "reason": "<string>"
}

{
  "errorMessage": "<string>",
  "reason": "<string>"
}

{
  "errorMessage": "<string>",
  "reason": "<string>"
}

Authorizations

Authorization

string

header

required

API token from cargo-ai login. Send as Authorization: Bearer <token>.

Headers

Idempotency-Key

string

Client-generated key that makes this write safe to retry. Reusing the same key with the same request returns the original response instead of creating a second record. Reusing it with a different request returns 422. A concurrent retry while the first request is still running returns 409. Keys expire after 24 hours. Not accepted on multipart file uploads. Optional: a request without one is processed as it always was.

Maximum string length: 255

Example:

"8e03978e-40d5-43e8-bc93-6894a57f9324"

Body

application/json

Request body schema.

name

string

required

Display name for the role.

Required string length: 1 - 255

slug

string

required

Unique snake_case identifier for the role.

Required string length: 1 - 63

Pattern: ^[a-z0-9]+(_[a-z0-9]+)*$

color

enum<string>

required

Color shown as a dot next to the role name.

Available options:

orange,

red,

purple,

green,

yellow,

grey

permissions

Permissions · object[]

required

Permission grants for the role.

Show child attributes

description

string

Optional description shown next to the role name.

Required string length: 1 - 1000

Response

Create role

role

object

required

Show child attributes