Role Profile

Gets a list of role profiles

get

This endpoint is used to fetch all the role profiles in the current organization (works based on token used to authorize)

Authorizations

Responses

application/json

object[]Optional

Serializes groups querysets.

get

HTTPcURLJavaScriptPython

GET /ux/common/roles/profile/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200Success

[
  {
    "role_name": "text",
    "description": "text",
    "group_id": 1,
    "organization": "text",
    "is_pre_configure": true,
    "role_type": 1,
    "event_map": "text",
    "last_update_time": "2025-04-18T23:46:13.637Z"
  }
]

Creates a new role

post

This endpoint is used to save a new role for the current organization

Authorizations

Body

Other propertiesanyOptional

Responses

post

HTTPcURLJavaScriptPython

POST /ux/common/roles/profile/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 190

{
  "role_name": "Requester",
  "description": "User can have access only to requester portal",
  "selected_permissions": {
    "General": {
      "organization": {
        "view": true,
        "add": true,
        "edit": true,
        "delete": true
      }
    }
  }
}

201

No response body

No content

Gets a role profile with the given id

get

This endpoint is used to fetch a role in the current organization

Authorizations

Path parameters

idstringRequired

Responses

application/json

objectOptional

Serializes groups querysets.

get

HTTPcURLJavaScriptPython

GET /ux/common/roles/profile/{id}/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200Success

{
  "role_name": "text",
  "description": "text",
  "group_id": 1,
  "organization": "text",
  "is_pre_configure": true,
  "role_type": 1,
  "event_map": "text",
  "last_update_time": "2025-04-18T23:46:13.637Z"
}

Edits the role with given id

put

This endpoint is used to edit an existing role for the current organization

Authorizations

Path parameters

idstringRequired

Body

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

Serializes groups querysets.

role_namestring | nullableOptional

descriptionstring | nullableOptional

group_idintegerOptional

organizationstring · max: 25Required

is_pre_configurebooleanOptional

role_typeintegerOptionalDefault: 1

event_mapstringRead-onlyRequired

last_update_timestring · date-timeOptional

Responses

application/json

objectOptional

Serializes groups querysets.

put

HTTPcURLJavaScriptPython

PUT /ux/common/roles/profile/{id}/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 160

{
  "role_name": "text",
  "description": "text",
  "group_id": 1,
  "organization": "text",
  "is_pre_configure": true,
  "role_type": 1,
  "last_update_time": "2025-04-18T23:46:13.637Z"
}

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

200Success

{
  "role_name": "text",
  "description": "text",
  "group_id": 1,
  "organization": "text",
  "is_pre_configure": true,
  "role_type": 1,
  "event_map": "text",
  "last_update_time": "2025-04-18T23:46:13.637Z"
}

Deletes the role with given id

delete

This endpoint is used to delete an existing role for the current organization

Authorizations

Path parameters

idstringRequired

Responses

delete

HTTPcURLJavaScriptPython

DELETE /ux/common/roles/profile/{id}/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

204

No response body

No content

Gets the module role map

get

This endpoint is used to get all module role map for the current organization

Authorizations

Responses

application/json

objectOptional

Serializes groups querysets.

get

HTTPcURLJavaScriptPython

GET /ux/common/roles/profile/config/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200Success

{
  "role_name": "text",
  "description": "text",
  "group_id": 1,
  "organization": "text",
  "is_pre_configure": true,
  "role_type": 1,
  "event_map": "text",
  "last_update_time": "2025-04-18T23:46:13.637Z"
}

get

API endpoint that allows users to be viewed or edited.

Authorizations

Responses

application/json

objectOptional

Serializes groups querysets.

get

HTTPcURLJavaScriptPython

GET /ux/common/roles/profile/json/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200Success

{
  "role_name": "text",
  "description": "text",
  "group_id": 1,
  "organization": "text",
  "is_pre_configure": true,
  "role_type": 1,
  "event_map": "text",
  "last_update_time": "2025-04-18T23:46:13.637Z"
}

Get the options for the events options

get

This endpoint is used to get the default options for events options

Authorizations

Responses

application/json

objectOptional

Serializes groups querysets.

get

HTTPcURLJavaScriptPython

GET /ux/common/roles/profile/options/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200Success

{
  "role_name": "text",
  "description": "text",
  "group_id": 1,
  "organization": "text",
  "is_pre_configure": true,
  "role_type": 1,
  "event_map": "text",
  "last_update_time": "2025-04-18T23:46:13.637Z"
}