Roles

Get All Roles

get
Authorizations
AuthorizationstringRequired

Enter your JWT token (without 'Bearer ' prefix)

Responses
chevron-right
200

Successful Response

application/json
anyOptional
get
/api/v1/roles_and_permissions
200

Successful Response

No content

Create Role

post
Authorizations
AuthorizationstringRequired

Enter your JWT token (without 'Bearer ' prefix)

Body
role_namestringRequired
descriptionany ofOptional
stringOptional
or
nullOptional
created_bystringRequired
can_submit_agentany ofOptionalDefault: false
booleanOptional
or
nullOptional
nav_permissionany ofOptional
or
nullOptional
action_permissionany ofOptional
or
nullOptional
is_editableany ofOptionalDefault: true
booleanOptional
or
nullOptional
Responses
chevron-right
200

Successful Response

application/json
role_idintegerRequired
role_namestringRequired
descriptionany ofOptional
stringOptional
or
nullOptional
created_bystringRequired
can_submit_agentbooleanRequired
is_editablebooleanRequired
post
/api/v1/roles_and_permissions

Get Role

get
Authorizations
AuthorizationstringRequired

Enter your JWT token (without 'Bearer ' prefix)

Path parameters
role_idintegerRequired
Responses
chevron-right
200

Successful Response

application/json
role_idintegerRequired
role_namestringRequired
descriptionany ofOptional
stringOptional
or
nullOptional
created_bystringRequired
can_submit_agentbooleanRequired
is_editablebooleanRequired
get
/api/v1/roles_and_permissions/{role_id}

Update Role

put
Authorizations
AuthorizationstringRequired

Enter your JWT token (without 'Bearer ' prefix)

Path parameters
role_idintegerRequired
Body
role_nameany ofOptional
stringOptional
or
nullOptional
can_submit_agentany ofOptional
booleanOptional
or
nullOptional
optionsany ofOptional
or
nullOptional
is_editableany ofOptional
booleanOptional
or
nullOptional
descriptionany ofOptional
stringOptional
or
nullOptional
Responses
chevron-right
200

Successful Response

application/json
role_idintegerRequired
role_namestringRequired
descriptionany ofOptional
stringOptional
or
nullOptional
created_bystringRequired
can_submit_agentbooleanRequired
is_editablebooleanRequired
put
/api/v1/roles_and_permissions/{role_id}

Delete Role

delete
Authorizations
AuthorizationstringRequired

Enter your JWT token (without 'Bearer ' prefix)

Path parameters
role_idintegerRequired
Responses
chevron-right
200

Successful Response

application/json
anyOptional
delete
/api/v1/roles_and_permissions/{role_id}

No content

Get All Custom Agents

get

Get all active custom agents for UI dropdowns.

Used when creating/editing roles to show available CustomAgents options.

Returns: List of active custom agents with basic info

Authorizations
AuthorizationstringRequired

Enter your JWT token (without 'Bearer ' prefix)

Responses
chevron-right
200

Successful Response

application/json
anyOptional
get
/api/v1/roles_and_permissions/custom_agents
200

Successful Response

No content

Reassign Users

post
Authorizations
AuthorizationstringRequired

Enter your JWT token (without 'Bearer ' prefix)

Query parameters
to_role_idintegerRequired
Bodyobject · RoleOption[]
entity_namestringRequired
entity_typeany ofOptional
string · enumOptionalPossible values:
or
nullOptional
entity_idany ofOptional
integerOptional
or
nullOptional
Responses
chevron-right
200

Successful Response

application/json
anyOptional
post
/api/v1/roles_and_permissions/reassign_users/

No content

Get Role By Username

get
Authorizations
AuthorizationstringRequired

Enter your JWT token (without 'Bearer ' prefix)

Path parameters
usernamestringRequired
Responses
chevron-right
200

Successful Response

application/json
anyOptional
get
/api/v1/roles_and_permissions/get_role_by_username/{username}

No content

Get Users By Role

get
Authorizations
AuthorizationstringRequired

Enter your JWT token (without 'Bearer ' prefix)

Path parameters
role_idintegerRequired
Responses
chevron-right
200

Successful Response

application/json
anyOptional
get
/api/v1/roles_and_permissions/get_users_by_role/{role_id}

No content

Get Llms By Role

get
Authorizations
AuthorizationstringRequired

Enter your JWT token (without 'Bearer ' prefix)

Path parameters
role_idintegerRequired
Responses
chevron-right
200

Successful Response

application/json
idintegerRequired
model_namestringRequired
descriptionany ofOptional
stringOptional
or
nullOptional
statusany ofOptionalDefault: Inactive
stringOptional
or
nullOptional
is_defaultany ofOptionalDefault: false
booleanOptional
or
nullOptional
connected_atany ofOptional
string · date-timeOptional
or
nullOptional
last_syncany ofOptional
string · date-timeOptional
or
nullOptional
get
/api/v1/roles_and_permissions/llms/{role_id}

Get Data Connectors By Role

get
Authorizations
AuthorizationstringRequired

Enter your JWT token (without 'Bearer ' prefix)

Path parameters
role_idintegerRequired
Responses
chevron-right
200

Successful Response

application/json
project_data_connector_idintegerRequired
project_idintegerRequired
data_connector_idintegerRequired
is_enabledbooleanRequired
last_status_change_atstring · date-timeRequired
get
/api/v1/roles_and_permissions/data_connectors/{role_id}

Get Files By Role

get
Authorizations
AuthorizationstringRequired

Enter your JWT token (without 'Bearer ' prefix)

Path parameters
role_idintegerRequired
Responses
chevron-right
200

Successful Response

application/json
project_idintegerRequired
uploader_usernamestring · max: 255Required
filenamestring · max: 255Required
storage_pathstring · max: 512Required
file_typeany ofOptional
string · max: 100Optional
or
nullOptional
file_size_bytesany ofOptional
integerOptional
or
nullOptional
processing_statusany ofOptionalDefault: uploaded
string · max: 50Optional
or
nullOptional
file_idintegerRequired
uploaded_atstring · date-timeRequired
get
/api/v1/roles_and_permissions/files/{role_id}

Get Devices By Role

get
Authorizations
AuthorizationstringRequired

Enter your JWT token (without 'Bearer ' prefix)

Path parameters
role_idintegerRequired
Responses
chevron-right
200

Successful Response

application/json
anyOptional
get
/api/v1/roles_and_permissions/devices/{role_id}

No content

Get Custom Agents By Role

get

Get custom agents assigned to a specific role.

Args: role_id: Role ID to get assigned agents for

Returns: List of custom agents assigned to the role

Authorizations
AuthorizationstringRequired

Enter your JWT token (without 'Bearer ' prefix)

Path parameters
role_idintegerRequired
Responses
chevron-right
200

Successful Response

application/json
anyOptional
get
/api/v1/roles_and_permissions/custom_agents/{role_id}

No content

Last updated