Skip to content

Role Groups

Roles can be organized into groups so you can more easily control access to your application. For example, you can add a role group to an organization for B2B scenarios so that their members can only be assigned roles that belong to this group. These APIs allow you to manage the role groups for your application. You can then use the Organizations APIs to add the relevant role groups to each organization and the Members API can be used to assign roles to their members.

Download OpenAPI description
role-groups.openapi.json
role-groups.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/

Create role group

Request

Create a new role group for this application.

Required permissions: organizations:create, roles:create.

Security
AdminAccessToken
Path
app_idstringrequired

ID of the application to create the role group in

Bodyapplication/jsonrequired
role_idsArray of stringsrequired

Ids of the roles

Example: ["role1","role2"]
namestringrequired

Name of the roles group

Example: "My Group"
descriptionstring

Description of the roles group

Example: "My Group's description"
display_namestring

Group display name

curl -i -X POST \
  'https://api.sbx.transmitsecurity.io/cis/v1/applications/{app_id}/role-groups' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "role_ids": [
      "role1",
      "role2"
    ],
    "name": "My Group",
    "description": "My Group'\''s description",
    "display_name": "string"
  }'

Responses

Bodyapplication/json
messagestringrequired
error_codenumberrequired
Response
application/json
{
  "message": "string",
  "error_code": 0
}

Get role groups

Request

Retrieve a list of all role groups created for this application.

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

Security
AdminAccessToken
Path
app_idstringrequired

ID of the application to retrieve it's role groups

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

Responses

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

Group ID

result[].​namestringrequired

Group name

result[].​descriptionstring

Group description

result[].​rolesArray of objectsrequired

Group's roles

result[].​roles[].​role_idstringrequired

Role ID

result[].​roles[].​role_namestringrequired

Role name

result[].​roles[].​permissionsArray of strings

Role permissions

result[].​roles[].​app_idstring

Role's app id

result[].​roles[].​descriptionstring

Role's description

result[].​roles[].​display_namestring

Role's display name

result[].​display_namestring

Role group's display name

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

Update role group

Request

Update an existing role group for this application.

Required permissions: organizations:edit, roles:edit.

Security
AdminAccessToken
Path
app_idstringrequired

ID of the application the group is in

group_idstringrequired

ID of the group to set the roles to

Bodyapplication/jsonrequired
namestring

Name of the roles group

Example: "My Group"
descriptionstring

Description of the roles group

Example: "My Group's description"
display_namestring

Group display name

role_idsstring

Ids of the roles

Example: ["role1","role2"]
curl -i -X PUT \
  'https://api.sbx.transmitsecurity.io/cis/v1/applications/{app_id}/role-groups/{group_id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "My Group",
    "description": "My Group'\''s description",
    "display_name": "string",
    "role_ids": [
      "role1",
      "role2"
    ]
  }'

Responses

Bodyapplication/json
messagestringrequired
error_codenumberrequired
Example: 404
Response
application/json
{
  "message": "string",
  "error_code": 404
}

Delete role group

Request

Delete role group.

Required permissions: organizations:delete, roles:delete.

Security
AdminAccessToken
Path
app_idstringrequired

ID of the application the group is in

group_idstringrequired

ID of the group to delete

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

Responses

Bodyapplication/json
messagestringrequired
error_codenumberrequired
Example: 404
Response
application/json
{
  "message": "string",
  "error_code": 404
}

Set role group's roles

Request

Update the roles of an existing role group of your application. This will replace any existing set of roles of that group.

Required permissions: organizations:edit, roles:edit.

Security
AdminAccessToken
Path
app_idstringrequired

ID of the application to set the roles to

group_idstringrequired

ID of the group to set the roles to

Bodyapplication/jsonrequired
role_idsArray of stringsrequired

Ids of the roles

Example: ["role1","role2"]
curl -i -X POST \
  'https://api.sbx.transmitsecurity.io/cis/v1/applications/{app_id}/role-groups/{group_id}/roles/set' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "role_ids": [
      "role1",
      "role2"
    ]
  }'

Responses