curl --request PUT \
--url https://api.edenai.run/v3/manage/groups/{external_group_id}/role/ \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"role_id": 123,
"priority": 0
}
'import requests
url = "https://api.edenai.run/v3/manage/groups/{external_group_id}/role/"
payload = {
"role_id": 123,
"priority": 0
}
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({role_id: 123, priority: 0})
};
fetch('https://api.edenai.run/v3/manage/groups/{external_group_id}/role/', 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.edenai.run/v3/manage/groups/{external_group_id}/role/",
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([
'role_id' => 123,
'priority' => 0
]),
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.edenai.run/v3/manage/groups/{external_group_id}/role/"
payload := strings.NewReader("{\n \"role_id\": 123,\n \"priority\": 0\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.edenai.run/v3/manage/groups/{external_group_id}/role/")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"role_id\": 123,\n \"priority\": 0\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.edenai.run/v3/manage/groups/{external_group_id}/role/")
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 \"role_id\": 123,\n \"priority\": 0\n}"
response = http.request(request)
puts response.read_body{
"external_group_id": "<string>",
"name": "<string>",
"members": [
"jsmith@example.com"
],
"mapped_role": {
"id": 123,
"name": "<string>",
"priority": 123
}
}Map a group to a role
Gives every member of a directory group a role, now and as the identity provider adds members. A member of several mapped groups gets the role of the group with the highest priority. A management key can only map roles limited to member management: roles granting organization or billing administration are refused (403), and so is a change that would let a member fall back to such a role through another mapped group. Returns the group; members is left out for a key without the manage:read scope. Requires the manage:write scope.
curl --request PUT \
--url https://api.edenai.run/v3/manage/groups/{external_group_id}/role/ \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"role_id": 123,
"priority": 0
}
'import requests
url = "https://api.edenai.run/v3/manage/groups/{external_group_id}/role/"
payload = {
"role_id": 123,
"priority": 0
}
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({role_id: 123, priority: 0})
};
fetch('https://api.edenai.run/v3/manage/groups/{external_group_id}/role/', 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.edenai.run/v3/manage/groups/{external_group_id}/role/",
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([
'role_id' => 123,
'priority' => 0
]),
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.edenai.run/v3/manage/groups/{external_group_id}/role/"
payload := strings.NewReader("{\n \"role_id\": 123,\n \"priority\": 0\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.edenai.run/v3/manage/groups/{external_group_id}/role/")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"role_id\": 123,\n \"priority\": 0\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.edenai.run/v3/manage/groups/{external_group_id}/role/")
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 \"role_id\": 123,\n \"priority\": 0\n}"
response = http.request(request)
puts response.read_body{
"external_group_id": "<string>",
"name": "<string>",
"members": [
"jsmith@example.com"
],
"mapped_role": {
"id": 123,
"name": "<string>",
"priority": 123
}
}Authorizations
Body
Response
A group synced from your identity provider. external_group_id is the group's id in the
identity provider and the identifier used in /manage/groups/{external_group_id} URLs;
members lists the emails of the group's active members. mapped_role is the role the group's
members get, or null: a member of several mapped groups gets the role of the one with the
highest priority.