Return as list of roles that are active and associated to the logged-in principal user.
curl --request GET \
--url https://{subdomain}.logicgate.com/api/v1/roles/user \
--header 'Authorization: Bearer <token>'import requests
url = "https://{subdomain}.logicgate.com/api/v1/roles/user"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://{subdomain}.logicgate.com/api/v1/roles/user', 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://{subdomain}.logicgate.com/api/v1/roles/user",
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://{subdomain}.logicgate.com/api/v1/roles/user"
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://{subdomain}.logicgate.com/api/v1/roles/user")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://{subdomain}.logicgate.com/api/v1/roles/user")
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[
{
"id": "<string>",
"active": true,
"created": "2023-11-07T05:31:56Z",
"updated": "2023-11-07T05:31:56Z",
"name": "<string>",
"locked": true,
"superAdmin": true,
"defaultRoleForNewUsers": true,
"autoprovisioned": true,
"externalId": "<string>",
"stepPermissionSets": [
{
"id": "<string>",
"active": true,
"created": "2023-11-07T05:31:56Z",
"updated": "2023-11-07T05:31:56Z",
"name": "<string>",
"locked": true,
"defaultStepPermissionSetForNewUsers": true,
"permissions": [
{
"created": "2023-11-07T05:31:56Z",
"updated": "2023-11-07T05:31:56Z",
"end": {
"stepType": "ORIGIN",
"name": "<string>",
"description": "<string>",
"priority": 123,
"userGroupOperationType": "FULL_ACCESS",
"xpos": 123,
"ypos": 123,
"commentsEnabled": true,
"documentsEnabled": true,
"externalUserMfaRequired": true,
"uxriEnabled": true,
"autofillEnabled": true,
"workflow": {
"id": "<string>",
"active": true,
"created": "2023-11-07T05:31:56Z",
"updated": "2023-11-07T05:31:56Z",
"application": {
"id": "<string>",
"active": true,
"created": "2023-11-07T05:31:56Z",
"updated": "2023-11-07T05:31:56Z",
"name": "<string>",
"createdBy": {
"id": "<string>",
"active": true,
"created": "2023-11-07T05:31:56Z",
"updated": "2023-11-07T05:31:56Z",
"discriminator": "<string>",
"status": "<string>",
"idOrTransientId": "<string>",
"transientIdOrId": "<string>",
"textOrNumericValue": "<string>",
"empty": true,
"email": "<string>",
"first": "<string>",
"last": "<string>"
},
"description": "<string>",
"color": "<string>",
"icon": "fa-bookmark, fa-bolt, fa-bullhorn, fa-certificate,fa-check-square-o, fa-cloud, fa-comments, fa-dollar, fa-exclamation-triangle, fa-file-text-o,fa-folder, fa-gift, fa-globe, fa-heartbeat, fa-leaf, fa-legal, fa-life-ring, fa-medkit, fa-money,fa-percent, fa-rocket, fa-signal, fa-university, fa-user-circle",
"type": "<string>",
"sourceApplicationId": "<string>",
"sourceEnvironment": "<string>",
"permissionsEnabled": true,
"imported": true,
"copied": true,
"live": true,
"currency": "EUR",
"uxriEnabled": true,
"shortCode": "<string>",
"defaultHomeScreen": {
"id": "<string>",
"active": true,
"created": "2023-11-07T05:31:56Z",
"updated": "2023-11-07T05:31:56Z"
}
},
"workflowType": "<string>"
},
"assignableUserType": "APP_AND_EXTERNAL_USERS",
"id": "<string>",
"active": true,
"created": "2023-11-07T05:31:56Z",
"updated": "2023-11-07T05:31:56Z",
"end": true,
"origin": true,
"chain": true
},
"operationType": "READ",
"permissionSetId": "<string>",
"neo4jId": "<string>",
"step": {
"stepType": "ORIGIN",
"name": "<string>",
"description": "<string>",
"priority": 123,
"userGroupOperationType": "FULL_ACCESS",
"xpos": 123,
"ypos": 123,
"commentsEnabled": true,
"documentsEnabled": true,
"externalUserMfaRequired": true,
"uxriEnabled": true,
"autofillEnabled": true,
"workflow": {
"id": "<string>",
"active": true,
"created": "2023-11-07T05:31:56Z",
"updated": "2023-11-07T05:31:56Z",
"application": {
"id": "<string>",
"active": true,
"created": "2023-11-07T05:31:56Z",
"updated": "2023-11-07T05:31:56Z",
"name": "<string>",
"createdBy": {
"id": "<string>",
"active": true,
"created": "2023-11-07T05:31:56Z",
"updated": "2023-11-07T05:31:56Z",
"discriminator": "<string>",
"status": "<string>",
"idOrTransientId": "<string>",
"transientIdOrId": "<string>",
"textOrNumericValue": "<string>",
"empty": true,
"email": "<string>",
"first": "<string>",
"last": "<string>"
},
"description": "<string>",
"color": "<string>",
"icon": "fa-bookmark, fa-bolt, fa-bullhorn, fa-certificate,fa-check-square-o, fa-cloud, fa-comments, fa-dollar, fa-exclamation-triangle, fa-file-text-o,fa-folder, fa-gift, fa-globe, fa-heartbeat, fa-leaf, fa-legal, fa-life-ring, fa-medkit, fa-money,fa-percent, fa-rocket, fa-signal, fa-university, fa-user-circle",
"type": "<string>",
"sourceApplicationId": "<string>",
"sourceEnvironment": "<string>",
"permissionsEnabled": true,
"imported": true,
"copied": true,
"live": true,
"currency": "EUR",
"uxriEnabled": true,
"shortCode": "<string>",
"defaultHomeScreen": {
"id": "<string>",
"active": true,
"created": "2023-11-07T05:31:56Z",
"updated": "2023-11-07T05:31:56Z"
}
},
"workflowType": "<string>"
},
"assignableUserType": "APP_AND_EXTERNAL_USERS",
"id": "<string>",
"active": true,
"created": "2023-11-07T05:31:56Z",
"updated": "2023-11-07T05:31:56Z",
"end": true,
"origin": true,
"chain": true
},
"type": "STEP_PERMISSION",
"endId": "<string>",
"startId": "<string>"
}
],
"users": [
{
"id": "<string>",
"active": true,
"created": "2023-11-07T05:31:56Z",
"updated": "2023-11-07T05:31:56Z",
"discriminator": "<string>",
"status": "<string>",
"idOrTransientId": "<string>",
"transientIdOrId": "<string>",
"textOrNumericValue": "<string>",
"empty": true,
"email": "<string>",
"first": "<string>",
"last": "<string>"
}
],
"application": {
"id": "<string>",
"active": true,
"created": "2023-11-07T05:31:56Z",
"updated": "2023-11-07T05:31:56Z",
"name": "<string>",
"createdBy": {
"id": "<string>",
"active": true,
"created": "2023-11-07T05:31:56Z",
"updated": "2023-11-07T05:31:56Z",
"discriminator": "<string>",
"status": "<string>",
"idOrTransientId": "<string>",
"transientIdOrId": "<string>",
"textOrNumericValue": "<string>",
"empty": true,
"email": "<string>",
"first": "<string>",
"last": "<string>"
},
"description": "<string>",
"color": "<string>",
"icon": "fa-bookmark, fa-bolt, fa-bullhorn, fa-certificate,fa-check-square-o, fa-cloud, fa-comments, fa-dollar, fa-exclamation-triangle, fa-file-text-o,fa-folder, fa-gift, fa-globe, fa-heartbeat, fa-leaf, fa-legal, fa-life-ring, fa-medkit, fa-money,fa-percent, fa-rocket, fa-signal, fa-university, fa-user-circle",
"type": "<string>",
"sourceApplicationId": "<string>",
"sourceEnvironment": "<string>",
"permissionsEnabled": true,
"imported": true,
"copied": true,
"live": true,
"currency": "EUR",
"uxriEnabled": true,
"shortCode": "<string>",
"defaultHomeScreen": {
"id": "<string>",
"active": true,
"created": "2023-11-07T05:31:56Z",
"updated": "2023-11-07T05:31:56Z"
}
},
"applicationId": "<string>",
"userIds": [
"<string>"
]
}
],
"moduleEntitlements": [
{
"created": "2023-11-07T05:31:56Z",
"updated": "2023-11-07T05:31:56Z",
"end": {
"id": "<string>",
"active": true,
"created": "2023-11-07T05:31:56Z",
"updated": "2023-11-07T05:31:56Z",
"value": "A_ASSIGN",
"onlyUse": true,
"tab": "<string>",
"name": "<string>"
},
"module": {
"id": "<string>",
"active": true,
"created": "2023-11-07T05:31:56Z",
"updated": "2023-11-07T05:31:56Z",
"value": "A_ASSIGN",
"onlyUse": true,
"tab": "<string>",
"name": "<string>"
},
"operationType": "READ",
"neo4jId": "<string>",
"type": "STEP_PERMISSION",
"endId": "<string>",
"startId": "<string>"
}
],
"userGroup": {
"id": "<string>",
"active": true,
"created": "2023-11-07T05:31:56Z",
"updated": "2023-11-07T05:31:56Z",
"title": "<string>"
},
"users": [
{
"id": "<string>",
"active": true,
"created": "2023-11-07T05:31:56Z",
"updated": "2023-11-07T05:31:56Z",
"discriminator": "<string>",
"status": "<string>",
"idOrTransientId": "<string>",
"transientIdOrId": "<string>",
"textOrNumericValue": "<string>",
"empty": true,
"email": "<string>",
"first": "<string>",
"last": "<string>"
}
],
"userCount": 123,
"moduleCount": 123
}
]Role
Find by principal (GET /api/v1/roles/user)
GET
/
api
/
v1
/
roles
/
user
Return as list of roles that are active and associated to the logged-in principal user.
curl --request GET \
--url https://{subdomain}.logicgate.com/api/v1/roles/user \
--header 'Authorization: Bearer <token>'import requests
url = "https://{subdomain}.logicgate.com/api/v1/roles/user"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://{subdomain}.logicgate.com/api/v1/roles/user', 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://{subdomain}.logicgate.com/api/v1/roles/user",
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://{subdomain}.logicgate.com/api/v1/roles/user"
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://{subdomain}.logicgate.com/api/v1/roles/user")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://{subdomain}.logicgate.com/api/v1/roles/user")
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[
{
"id": "<string>",
"active": true,
"created": "2023-11-07T05:31:56Z",
"updated": "2023-11-07T05:31:56Z",
"name": "<string>",
"locked": true,
"superAdmin": true,
"defaultRoleForNewUsers": true,
"autoprovisioned": true,
"externalId": "<string>",
"stepPermissionSets": [
{
"id": "<string>",
"active": true,
"created": "2023-11-07T05:31:56Z",
"updated": "2023-11-07T05:31:56Z",
"name": "<string>",
"locked": true,
"defaultStepPermissionSetForNewUsers": true,
"permissions": [
{
"created": "2023-11-07T05:31:56Z",
"updated": "2023-11-07T05:31:56Z",
"end": {
"stepType": "ORIGIN",
"name": "<string>",
"description": "<string>",
"priority": 123,
"userGroupOperationType": "FULL_ACCESS",
"xpos": 123,
"ypos": 123,
"commentsEnabled": true,
"documentsEnabled": true,
"externalUserMfaRequired": true,
"uxriEnabled": true,
"autofillEnabled": true,
"workflow": {
"id": "<string>",
"active": true,
"created": "2023-11-07T05:31:56Z",
"updated": "2023-11-07T05:31:56Z",
"application": {
"id": "<string>",
"active": true,
"created": "2023-11-07T05:31:56Z",
"updated": "2023-11-07T05:31:56Z",
"name": "<string>",
"createdBy": {
"id": "<string>",
"active": true,
"created": "2023-11-07T05:31:56Z",
"updated": "2023-11-07T05:31:56Z",
"discriminator": "<string>",
"status": "<string>",
"idOrTransientId": "<string>",
"transientIdOrId": "<string>",
"textOrNumericValue": "<string>",
"empty": true,
"email": "<string>",
"first": "<string>",
"last": "<string>"
},
"description": "<string>",
"color": "<string>",
"icon": "fa-bookmark, fa-bolt, fa-bullhorn, fa-certificate,fa-check-square-o, fa-cloud, fa-comments, fa-dollar, fa-exclamation-triangle, fa-file-text-o,fa-folder, fa-gift, fa-globe, fa-heartbeat, fa-leaf, fa-legal, fa-life-ring, fa-medkit, fa-money,fa-percent, fa-rocket, fa-signal, fa-university, fa-user-circle",
"type": "<string>",
"sourceApplicationId": "<string>",
"sourceEnvironment": "<string>",
"permissionsEnabled": true,
"imported": true,
"copied": true,
"live": true,
"currency": "EUR",
"uxriEnabled": true,
"shortCode": "<string>",
"defaultHomeScreen": {
"id": "<string>",
"active": true,
"created": "2023-11-07T05:31:56Z",
"updated": "2023-11-07T05:31:56Z"
}
},
"workflowType": "<string>"
},
"assignableUserType": "APP_AND_EXTERNAL_USERS",
"id": "<string>",
"active": true,
"created": "2023-11-07T05:31:56Z",
"updated": "2023-11-07T05:31:56Z",
"end": true,
"origin": true,
"chain": true
},
"operationType": "READ",
"permissionSetId": "<string>",
"neo4jId": "<string>",
"step": {
"stepType": "ORIGIN",
"name": "<string>",
"description": "<string>",
"priority": 123,
"userGroupOperationType": "FULL_ACCESS",
"xpos": 123,
"ypos": 123,
"commentsEnabled": true,
"documentsEnabled": true,
"externalUserMfaRequired": true,
"uxriEnabled": true,
"autofillEnabled": true,
"workflow": {
"id": "<string>",
"active": true,
"created": "2023-11-07T05:31:56Z",
"updated": "2023-11-07T05:31:56Z",
"application": {
"id": "<string>",
"active": true,
"created": "2023-11-07T05:31:56Z",
"updated": "2023-11-07T05:31:56Z",
"name": "<string>",
"createdBy": {
"id": "<string>",
"active": true,
"created": "2023-11-07T05:31:56Z",
"updated": "2023-11-07T05:31:56Z",
"discriminator": "<string>",
"status": "<string>",
"idOrTransientId": "<string>",
"transientIdOrId": "<string>",
"textOrNumericValue": "<string>",
"empty": true,
"email": "<string>",
"first": "<string>",
"last": "<string>"
},
"description": "<string>",
"color": "<string>",
"icon": "fa-bookmark, fa-bolt, fa-bullhorn, fa-certificate,fa-check-square-o, fa-cloud, fa-comments, fa-dollar, fa-exclamation-triangle, fa-file-text-o,fa-folder, fa-gift, fa-globe, fa-heartbeat, fa-leaf, fa-legal, fa-life-ring, fa-medkit, fa-money,fa-percent, fa-rocket, fa-signal, fa-university, fa-user-circle",
"type": "<string>",
"sourceApplicationId": "<string>",
"sourceEnvironment": "<string>",
"permissionsEnabled": true,
"imported": true,
"copied": true,
"live": true,
"currency": "EUR",
"uxriEnabled": true,
"shortCode": "<string>",
"defaultHomeScreen": {
"id": "<string>",
"active": true,
"created": "2023-11-07T05:31:56Z",
"updated": "2023-11-07T05:31:56Z"
}
},
"workflowType": "<string>"
},
"assignableUserType": "APP_AND_EXTERNAL_USERS",
"id": "<string>",
"active": true,
"created": "2023-11-07T05:31:56Z",
"updated": "2023-11-07T05:31:56Z",
"end": true,
"origin": true,
"chain": true
},
"type": "STEP_PERMISSION",
"endId": "<string>",
"startId": "<string>"
}
],
"users": [
{
"id": "<string>",
"active": true,
"created": "2023-11-07T05:31:56Z",
"updated": "2023-11-07T05:31:56Z",
"discriminator": "<string>",
"status": "<string>",
"idOrTransientId": "<string>",
"transientIdOrId": "<string>",
"textOrNumericValue": "<string>",
"empty": true,
"email": "<string>",
"first": "<string>",
"last": "<string>"
}
],
"application": {
"id": "<string>",
"active": true,
"created": "2023-11-07T05:31:56Z",
"updated": "2023-11-07T05:31:56Z",
"name": "<string>",
"createdBy": {
"id": "<string>",
"active": true,
"created": "2023-11-07T05:31:56Z",
"updated": "2023-11-07T05:31:56Z",
"discriminator": "<string>",
"status": "<string>",
"idOrTransientId": "<string>",
"transientIdOrId": "<string>",
"textOrNumericValue": "<string>",
"empty": true,
"email": "<string>",
"first": "<string>",
"last": "<string>"
},
"description": "<string>",
"color": "<string>",
"icon": "fa-bookmark, fa-bolt, fa-bullhorn, fa-certificate,fa-check-square-o, fa-cloud, fa-comments, fa-dollar, fa-exclamation-triangle, fa-file-text-o,fa-folder, fa-gift, fa-globe, fa-heartbeat, fa-leaf, fa-legal, fa-life-ring, fa-medkit, fa-money,fa-percent, fa-rocket, fa-signal, fa-university, fa-user-circle",
"type": "<string>",
"sourceApplicationId": "<string>",
"sourceEnvironment": "<string>",
"permissionsEnabled": true,
"imported": true,
"copied": true,
"live": true,
"currency": "EUR",
"uxriEnabled": true,
"shortCode": "<string>",
"defaultHomeScreen": {
"id": "<string>",
"active": true,
"created": "2023-11-07T05:31:56Z",
"updated": "2023-11-07T05:31:56Z"
}
},
"applicationId": "<string>",
"userIds": [
"<string>"
]
}
],
"moduleEntitlements": [
{
"created": "2023-11-07T05:31:56Z",
"updated": "2023-11-07T05:31:56Z",
"end": {
"id": "<string>",
"active": true,
"created": "2023-11-07T05:31:56Z",
"updated": "2023-11-07T05:31:56Z",
"value": "A_ASSIGN",
"onlyUse": true,
"tab": "<string>",
"name": "<string>"
},
"module": {
"id": "<string>",
"active": true,
"created": "2023-11-07T05:31:56Z",
"updated": "2023-11-07T05:31:56Z",
"value": "A_ASSIGN",
"onlyUse": true,
"tab": "<string>",
"name": "<string>"
},
"operationType": "READ",
"neo4jId": "<string>",
"type": "STEP_PERMISSION",
"endId": "<string>",
"startId": "<string>"
}
],
"userGroup": {
"id": "<string>",
"active": true,
"created": "2023-11-07T05:31:56Z",
"updated": "2023-11-07T05:31:56Z",
"title": "<string>"
},
"users": [
{
"id": "<string>",
"active": true,
"created": "2023-11-07T05:31:56Z",
"updated": "2023-11-07T05:31:56Z",
"discriminator": "<string>",
"status": "<string>",
"idOrTransientId": "<string>",
"transientIdOrId": "<string>",
"textOrNumericValue": "<string>",
"empty": true,
"email": "<string>",
"first": "<string>",
"last": "<string>"
}
],
"userCount": 123,
"moduleCount": 123
}
]Authorizations
ApiTokenbasic
Response
200 - application/json
OK