Skip to content

Roles

Manage user roles and permissions

Download OpenAPI description
roles.openapi.json
roles.openapi.yaml
Languages
Servers
Sandbox environment
https://api.sbx.transmitsecurity.io/cis/
Production environment (US)
https://api.transmitsecurity.io/cis/
Production environment (EU)
https://api.eu.transmitsecurity.io/cis/
Production environment (CA)
https://api.ca.transmitsecurity.io/cis/
Production environment (AU)
https://api.au.transmitsecurity.io/cis/

Assign role

Request

Assign a role to users or groups

Security
AdminAccessToken
Path
app_idstringrequired

ID of the application

role_idstringrequired

ID of the role to assign

Bodyapplication/jsonrequired
entity_idsArray of stringsrequired

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

entity_typestringrequired

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

Enum"User""Group""Application"
curl -i -X POST \
  'https://api.sbx.transmitsecurity.io/cis/v1/applications/{app_id}/roles/{role_id}/assignments' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "entity_ids": [
      "string"
    ],
    "entity_type": "User"
  }'

Responses

Response
No content

Revoke role

Request

Delete user or group assignment from a role

Security
AdminAccessToken
Path
app_idstringrequired

ID of the application

role_idstringrequired

ID of the role to revoke

entity_idstringrequired

ID of the user or group to revoke role from

curl -i -X DELETE \
  'https://api.sbx.transmitsecurity.io/cis/v1/applications/{app_id}/roles/{role_id}/assignments/{entity_id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Response
No content

Create role

Request

Create a new role for this application.

Required permissions: organizations:create, roles:create.

Security
AdminAccessToken
Path
app_idstringrequired

ID of the application to retrieve its roles

Bodyapplication/jsonrequired
role_namestringrequired

Role name

permissionsArray of strings

Role permissions

descriptionstring

Role description

display_namestring

Role display name

curl -i -X POST \
  'https://api.sbx.transmitsecurity.io/cis/v1/applications/{app_id}/roles' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "role_name": "string",
    "permissions": [
      "string"
    ],
    "description": "string",
    "display_name": "string"
  }'

Responses

Bodyapplication/json
resultobjectrequired
result.​resultobjectrequired
Response
application/json
{
  "result": {
    "result": {}
  }
}

Get roles

Request

Retrieve a list of all roles created for this application.

Required permissions: organizations:read, roles:read, organizations:list, roles:list.

Security
AdminAccessToken
Path
app_idstringrequired

ID of the application to retrieve it's roles

curl -i -X GET \
  'https://api.sbx.transmitsecurity.io/cis/v1/applications/{app_id}/roles' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Bodyapplication/json
resultArray of objectsrequired
result[].​role_idstringrequired

Role ID

result[].​role_namestringrequired

Role name

result[].​permissionsArray of strings

Role permissions

result[].​app_idstring

Role's app id

result[].​descriptionstring

Role's description

result[].​display_namestring

Role's display name

Response
application/json
{
  "result": [
    { … }
  ]
}

Get role by ID

Request

Retrieve a role by ID.

Required permissions: organizations:read, roles:read.

Security
AdminAccessToken
Path
app_idstringrequired

ID of the application to retrieve its roles

role_idstringrequired

ID of the role to retrieve

curl -i -X GET \
  'https://api.sbx.transmitsecurity.io/cis/v1/applications/{app_id}/roles/{role_id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Bodyapplication/json
resultobjectrequired
result.​role_idstringrequired

Role ID

result.​role_namestringrequired

Role name

result.​permissionsArray of strings

Role permissions

result.​app_idstring

Role's app id

result.​descriptionstring

Role's description

result.​display_namestring

Role's display name

Response
application/json
{
  "result": {
    "role_id": "string",
    "role_name": "string",
    "permissions": [ … ],
    "app_id": "string",
    "description": "string",
    "display_name": "string"
  }
}

Update role

Request

Update an existing role for this application.

Required permissions: organizations:edit, roles:edit.

Security
AdminAccessToken
Path
app_idstringrequired

ID of the application to retrieve it's roles

role_idstringrequired

ID of the role to update

Bodyapplication/jsonrequired
role_namestring

Role name

permissionsArray of strings

Role permissions

descriptionstring

Role description

display_namestring

Role display name

curl -i -X PUT \
  'https://api.sbx.transmitsecurity.io/cis/v1/applications/{app_id}/roles/{role_id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "role_name": "string",
    "permissions": [
      "string"
    ],
    "description": "string",
    "display_name": "string"
  }'

Responses

Bodyapplication/json
resultobjectrequired
Response
application/json
{
  "result": {}
}

Delete role

Request

Delete role from this application.

Required permissions: organizations:delete, roles:delete.

Security
AdminAccessToken
Path
app_idstringrequired

ID of the application to delete the role from

role_idstringrequired

ID of the role to delete

curl -i -X DELETE \
  'https://api.sbx.transmitsecurity.io/cis/v1/applications/{app_id}/roles/{role_id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses