Retrieve user model roles
curl --request GET \
--url https://{instance}.omniapp.co/api/v1/users/{userId}/model-roles \
--header 'Authorization: Bearer <token>'import requests
url = "https://{instance}.omniapp.co/api/v1/users/{userId}/model-roles"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://{instance}.omniapp.co/api/v1/users/{userId}/model-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://{instance}.omniapp.co/api/v1/users/{userId}/model-roles",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://{instance}.omniapp.co/api/v1/users/{userId}/model-roles"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://{instance}.omniapp.co/api/v1/users/{userId}/model-roles")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://{instance}.omniapp.co/api/v1/users/{userId}/model-roles")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"membershipId": "9633bd79-7bdf-4773-8952-8fdd4098e51c",
"results": [
{
"baseRole": "MODELER",
"from": {
"type": "User Role"
},
"priority": 350,
"resolved": true,
"roleName": "MODELER",
"connectionId": "8a464dc9-1f0e-4a9e-86fa-e1e6d970157c",
"modelId": "5fb90312-67b1-4cca-823a-9a341d549320"
},
{
"baseRole": "QUERIER",
"from": {
"depth": 0,
"miniUuid": "PgjffoEu",
"name": "Super Group",
"type": "Group Role"
},
"priority": 250,
"resolved": false,
"roleName": "QUERIER",
"connectionId": "8a464dc9-1f0e-4a9e-86fa-e1e6d970157c",
"modelId": "5fb90312-67b1-4cca-823a-9a341d549320"
},
{
"baseRole": "VIEWER",
"from": {
"type": "Connection Base Role"
},
"priority": 50,
"resolved": false,
"roleName": "VIEWER",
"connectionId": "8a464dc9-1f0e-4a9e-86fa-e1e6d970157c",
"modelId": "5fb90312-67b1-4cca-823a-9a341d549320"
}
]
}{
"detail": "User not found in organization",
"status": 404
}{
"error": "<response_code>",
"message": "<error_reason>"
}Model roles
Retrieve user model roles
Retrieve the model role assignments for a user. This includes both direct role assignments and roles inherited from user group memberships.
GET
/
v1
/
users
/
{userId}
/
model-roles
Retrieve user model roles
curl --request GET \
--url https://{instance}.omniapp.co/api/v1/users/{userId}/model-roles \
--header 'Authorization: Bearer <token>'import requests
url = "https://{instance}.omniapp.co/api/v1/users/{userId}/model-roles"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://{instance}.omniapp.co/api/v1/users/{userId}/model-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://{instance}.omniapp.co/api/v1/users/{userId}/model-roles",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://{instance}.omniapp.co/api/v1/users/{userId}/model-roles"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://{instance}.omniapp.co/api/v1/users/{userId}/model-roles")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://{instance}.omniapp.co/api/v1/users/{userId}/model-roles")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"membershipId": "9633bd79-7bdf-4773-8952-8fdd4098e51c",
"results": [
{
"baseRole": "MODELER",
"from": {
"type": "User Role"
},
"priority": 350,
"resolved": true,
"roleName": "MODELER",
"connectionId": "8a464dc9-1f0e-4a9e-86fa-e1e6d970157c",
"modelId": "5fb90312-67b1-4cca-823a-9a341d549320"
},
{
"baseRole": "QUERIER",
"from": {
"depth": 0,
"miniUuid": "PgjffoEu",
"name": "Super Group",
"type": "Group Role"
},
"priority": 250,
"resolved": false,
"roleName": "QUERIER",
"connectionId": "8a464dc9-1f0e-4a9e-86fa-e1e6d970157c",
"modelId": "5fb90312-67b1-4cca-823a-9a341d549320"
},
{
"baseRole": "VIEWER",
"from": {
"type": "Connection Base Role"
},
"priority": 50,
"resolved": false,
"roleName": "VIEWER",
"connectionId": "8a464dc9-1f0e-4a9e-86fa-e1e6d970157c",
"modelId": "5fb90312-67b1-4cca-823a-9a341d549320"
}
]
}{
"detail": "User not found in organization",
"status": 404
}{
"error": "<response_code>",
"message": "<error_reason>"
}Authorizations
Can be either an Organization API Key or Personal Access Token (PAT).
Include in the Authorization header as: Bearer YOUR_TOKEN
Path Parameters
The ID of the user to retrieve model roles for.
Query Parameters
Filter results to a specific model ID. If not provided, returns roles for all models the user has access to.
Filter results to models from a specific connection. If not provided, returns roles for all connections.
Was this page helpful?
⌘I

