Roles

Download OpenAPI specification:Download

Manage user roles and permissions

Create role

Create a new role

SecurityHTTP: bearer
Request
Request Body schema: application/json
role_name
required
string

New role name

Responses
201
400
409
post/v1/roles
Request samples
application/json
{
  • "role_name": "string"
}
Response samples
application/json
{
  • "result": {
    }
}

Get roles

Retrieve a list of all roles

SecurityHTTP: bearer
Responses
200
get/v1/roles
Request samples
curl -i -X GET \
  https://api.transmitsecurity.io/cis/v1/roles \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "result": [
    ]
}

Get role assignments

Retrieve role assignments for entities. For example, you can get all roles assigned to users, all roles assigned to a specific group, or all assignments of a specific role to users.

SecurityHTTP: bearer
Request
query Parameters
entity_ids
Array of strings

List of entity IDs to retrieve assignments for

entity_type
string

Type of entities to retrieve assigned roles for

Enum: "User" "Group" "Application"
role_ids
Array of strings

List of entity IDs to retrieve assignments for

Responses
200
400
get/v1/roles/assignments
Request samples
curl -i -X GET \
  'https://api.transmitsecurity.io/cis/v1/roles/assignments?entity_ids=string&entity_type=User&role_ids=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "result": [
    ]
}

Get assigned roles

Retrieve roles for a user or group

SecurityHTTP: bearer
Request
path Parameters
entity_id
required
string

ID of the entity(User/Group) to retrieve assigned roles

Responses
200

The role has been successfully fetched.

400
get/v1/roles/assignments/{entity_id}
Request samples
curl -i -X GET \
  'https://api.transmitsecurity.io/cis/v1/roles/assignments/{entity_id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "result": [
    ]
}

Get role by ID

Retrieve a role by ID

SecurityHTTP: bearer
Request
path Parameters
role_id
required
string

ID of the role to retrieve

Responses
200
404
get/v1/roles/{role_id}
Request samples
curl -i -X GET \
  'https://api.transmitsecurity.io/cis/v1/roles/{role_id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "result": {
    }
}

Update role

Update a role

SecurityHTTP: bearer
Request
path Parameters
role_id
required
string

ID of the role to update

Request Body schema: application/json
role_name
required
string

New role name

Responses
200
400
404
put/v1/roles/{role_id}
Request samples
application/json
{
  • "role_name": "string"
}
Response samples
application/json
{
  • "result": {
    }
}

Delete role

Delete a role

SecurityHTTP: bearer
Request
path Parameters
role_id
required
string

ID of the role to delete

Responses
204
400
404
delete/v1/roles/{role_id}
Request samples
curl -i -X DELETE \
  'https://api.transmitsecurity.io/cis/v1/roles/{role_id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "message": "Bad request",
  • "error_code": 400
}

Assign role to entity

Assign users or groups to a role

SecurityHTTP: bearer
Request
path Parameters
role_id
required
string

ID of the role to assign

Request Body schema: application/json
entity_ids
required
Array of strings

List of entities to assign the role. All entites must be of the same type.

entity_type
required
string (Entity type)

Type of entities to assign the role. All entities in entity_ids must be of this type.

Enum: "User" "Group" "Application"
Responses
204
400
404
post/v1/roles/{role_id}/assignments
Request samples
application/json
{
  • "entity_ids": [
    ],
  • "entity_type": "User"
}
Response samples
application/json
{
  • "message": "Bad request",
  • "error_code": 400
}

Unassign role from entity

Delete user or group assignment from a role

SecurityHTTP: bearer
Request
path Parameters
role_id
required
string

ID of the role to unassign

entity_id
required
string

ID of the entity(User/Group) to unassign

Responses
204
400
404
delete/v1/roles/{role_id}/assignments/{entity_id}
Request samples
curl -i -X DELETE \
  'https://api.transmitsecurity.io/cis/v1/roles/{role_id}/assignments/{entity_id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "message": "Bad request",
  • "error_code": 400
}

Update role permissions

Update permissions associated with a role

SecurityHTTP: bearer
Request
path Parameters
role_id
required
string

ID of the role to update

Request Body schema: application/json
permissions
required
Array of strings

Names of permissions

Responses
200
400
404
put/v1/roles/{role_id}/permissions
Request samples
application/json
{
  • "permissions": [
    ]
}
Response samples
application/json
{
  • "role_id": "string",
  • "role_name": "string",
  • "permissions": [
    ]
}