Product DocsSchemaAuthentication

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
200Success
application/json
get
/ux/common/roles/profile/
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-10-19T00:47:45.398Z"
  }
]

Creates a new role

post

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

Authorizations
Body
Other propertiesanyOptional
Responses
201

No response body

No content
post
/ux/common/roles/profile/
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
200Success
application/json
get
/ux/common/roles/profile/{id}/
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-10-19T00:47:45.398Z"
}

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

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
200Success
application/json
put
/ux/common/roles/profile/{id}/
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-10-19T00:47:45.398Z"
}
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-10-19T00:47:45.398Z"
}

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
204

No response body

No content
delete
/ux/common/roles/profile/{id}/
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
200Success
application/json
get
/ux/common/roles/profile/config/
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-10-19T00:47:45.398Z"
}
get

API endpoint that allows users to be viewed or edited.

Authorizations
Responses
200Success
application/json
get
/ux/common/roles/profile/json/
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-10-19T00:47:45.398Z"
}

Get the options for the events options

get

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

Authorizations
Responses
200Success
application/json
get
/ux/common/roles/profile/options/
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-10-19T00:47:45.398Z"
}
PreviousService Feasibility RequestsNextService_outage