Reorder group-to-role mapping priority

Reorder role mappings

curl --request PUT \
  --url https://api.onecli.sh/v1/org/role-mappings/order \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "orderedIds": [
    "<string>"
  ]
}
'

import requests

url = "https://api.onecli.sh/v1/org/role-mappings/order"

payload = { "orderedIds": ["<string>"] }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({orderedIds: ['<string>']})
};

fetch('https://api.onecli.sh/v1/org/role-mappings/order', 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.onecli.sh/v1/org/role-mappings/order",
  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([
    'orderedIds' => [
        '<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.onecli.sh/v1/org/role-mappings/order"

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

	req, _ := http.NewRequest("PUT", 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.put("https://api.onecli.sh/v1/org/role-mappings/order")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"orderedIds\": [\n    \"<string>\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.onecli.sh/v1/org/role-mappings/order")

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

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"orderedIds\": [\n    \"<string>\"\n  ]\n}"

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

[
  {
    "id": "<string>",
    "groupId": "<string>",
    "groupName": "<string>",
    "role": "admin",
    "priority": 123,
    "memberCount": 123,
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z"
  }
]

{
  "error": "<string>"
}

{
  "error": "<string>"
}

PUT

org

role-mappings

order

Reorder role mappings

curl --request PUT \
  --url https://api.onecli.sh/v1/org/role-mappings/order \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "orderedIds": [
    "<string>"
  ]
}
'

import requests

url = "https://api.onecli.sh/v1/org/role-mappings/order"

payload = { "orderedIds": ["<string>"] }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({orderedIds: ['<string>']})
};

fetch('https://api.onecli.sh/v1/org/role-mappings/order', 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.onecli.sh/v1/org/role-mappings/order",
  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([
    'orderedIds' => [
        '<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.onecli.sh/v1/org/role-mappings/order"

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

	req, _ := http.NewRequest("PUT", 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.put("https://api.onecli.sh/v1/org/role-mappings/order")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"orderedIds\": [\n    \"<string>\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.onecli.sh/v1/org/role-mappings/order")

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

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"orderedIds\": [\n    \"<string>\"\n  ]\n}"

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

[
  {
    "id": "<string>",
    "groupId": "<string>",
    "groupName": "<string>",
    "role": "admin",
    "priority": 123,
    "memberCount": 123,
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z"
  }
]

{
  "error": "<string>"
}

{
  "error": "<string>"
}

Sets mapping priority, highest first, and must name every mapping exactly once. Members who belong to several mapped groups are re-resolved immediately, so preview a risky change first. Highest priority first; must name every mapping exactly once. Members of several mapped groups are re-resolved.

Availability: Cloud · Enterprise (self-hosted). Not available on the Community edition: a self-hosted deployment needs ENTERPRISE_ENABLED=true, otherwise the endpoint answers 403 with error.type: "enterprise_license_required".

Authorizations

Authorization

string

header

required

A workspace API key (oc_…) or organization API key (oc_org_…). Workspace-scoped endpoints called with an organization key also need X-Workspace-Id.

Body

application/json

orderedIds

string[]

required

Minimum array length: 1

Response

The reordered mappings

string

groupId

string

groupName

string

role

enum<string>

Available options:

admin,

member

priority

integer

Lower wins when a member belongs to several mapped groups.

memberCount

integer

createdAt

string<date-time>

updatedAt

string<date-time>

Workspace

Organization

Enterprise

Platform

Reorder group-to-role mapping priority

Authorizations

Body

Response