Create Role - Confidence Documentation

POST

/

v1

/

roles

Create Role

curl --request POST \
  --url https://iam.eu.confidence.dev/v1/roles \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "displayName": "<string>",
  "permissions": [
    {
      "description": "<string>"
    }
  ],
  "name": "<string>",
  "labels": [
    {}
  ],
  "owner": "<string>"
}
'

import requests

url = "https://iam.eu.confidence.dev/v1/roles"

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

fetch('https://iam.eu.confidence.dev/v1/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://iam.eu.confidence.dev/v1/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([
    'displayName' => '<string>',
    'permissions' => [
        [
                'description' => '<string>'
        ]
    ],
    'name' => '<string>',
    'labels' => [
        [
                
        ]
    ],
    'owner' => '<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://iam.eu.confidence.dev/v1/roles"

	payload := strings.NewReader("{\n  \"displayName\": \"<string>\",\n  \"permissions\": [\n    {\n      \"description\": \"<string>\"\n    }\n  ],\n  \"name\": \"<string>\",\n  \"labels\": [\n    {}\n  ],\n  \"owner\": \"<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://iam.eu.confidence.dev/v1/roles")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"displayName\": \"<string>\",\n  \"permissions\": [\n    {\n      \"description\": \"<string>\"\n    }\n  ],\n  \"name\": \"<string>\",\n  \"labels\": [\n    {}\n  ],\n  \"owner\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://iam.eu.confidence.dev/v1/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  \"displayName\": \"<string>\",\n  \"permissions\": [\n    {\n      \"description\": \"<string>\"\n    }\n  ],\n  \"name\": \"<string>\",\n  \"labels\": [\n    {}\n  ],\n  \"owner\": \"<string>\"\n}"

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

{
  "displayName": "<string>",
  "permissions": [
    {
      "category": "CATEGORY_UNSPECIFIED",
      "type": "TYPE_UNSPECIFIED",
      "description": "<string>"
    }
  ],
  "creator": "<string>",
  "updater": "<string>",
  "createTime": {},
  "updateTime": {},
  "name": "<string>",
  "builtin": true,
  "labels": [
    {}
  ],
  "owner": "<string>"
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

roleId

string

The id to the give the created role. If a not set a random one will be generated.

Body

application/json

displayName

string

required

Human friendly name of the role.

permissions

object[]

required

List of permissions that this role has, needs to have at least one.

Show child attributes

name

string

Name of the role on the form roles/{"<"}id{">"}.

labels

object[]

General labels for this resource.

Show child attributes

owner

string

The owner of the resource. If not set will default to the creator.

Response

200 - application/json

Returns a Role.

A role is a named set of permissions, like Admin or Flag Editor.

displayName

string

required

Human friendly name of the role.

permissions

object[]

required

List of permissions that this role has, needs to have at least one.

Show child attributes

creator

string

required

Reference to the identity that created this OAuthApp.

updater

string

required

Reference to the identity that last updated this OAuthApp.

createTime

object

required

Time when the role was first created.

updateTime

object

required

Time when the role was last updated.

name

string

Name of the role on the form roles/{"<"}id{">"}.

builtin

boolean

If this role is automatically built in or not

labels

object[]

General labels for this resource.

Show child attributes

owner

string

The owner of the resource. If not set will default to the creator.

⌘I

Create Role

curl --request POST \
  --url https://iam.eu.confidence.dev/v1/roles \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "displayName": "<string>",
  "permissions": [
    {
      "description": "<string>"
    }
  ],
  "name": "<string>",
  "labels": [
    {}
  ],
  "owner": "<string>"
}
'

import requests

url = "https://iam.eu.confidence.dev/v1/roles"

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

fetch('https://iam.eu.confidence.dev/v1/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://iam.eu.confidence.dev/v1/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([
    'displayName' => '<string>',
    'permissions' => [
        [
                'description' => '<string>'
        ]
    ],
    'name' => '<string>',
    'labels' => [
        [
                
        ]
    ],
    'owner' => '<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://iam.eu.confidence.dev/v1/roles"

	payload := strings.NewReader("{\n  \"displayName\": \"<string>\",\n  \"permissions\": [\n    {\n      \"description\": \"<string>\"\n    }\n  ],\n  \"name\": \"<string>\",\n  \"labels\": [\n    {}\n  ],\n  \"owner\": \"<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://iam.eu.confidence.dev/v1/roles")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"displayName\": \"<string>\",\n  \"permissions\": [\n    {\n      \"description\": \"<string>\"\n    }\n  ],\n  \"name\": \"<string>\",\n  \"labels\": [\n    {}\n  ],\n  \"owner\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://iam.eu.confidence.dev/v1/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  \"displayName\": \"<string>\",\n  \"permissions\": [\n    {\n      \"description\": \"<string>\"\n    }\n  ],\n  \"name\": \"<string>\",\n  \"labels\": [\n    {}\n  ],\n  \"owner\": \"<string>\"\n}"

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

{
  "displayName": "<string>",
  "permissions": [
    {
      "category": "CATEGORY_UNSPECIFIED",
      "type": "TYPE_UNSPECIFIED",
      "description": "<string>"
    }
  ],
  "creator": "<string>",
  "updater": "<string>",
  "createTime": {},
  "updateTime": {},
  "name": "<string>",
  "builtin": true,
  "labels": [
    {}
  ],
  "owner": "<string>"
}