Groups

Manage user groups

Download OpenAPI description

groups.openapi.json

groups.openapi.yaml

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 group

Request

Create a group for your users.

Required permissions: apps:create, [appId]:create, groups:create.

Security

ClientAccessToken

Bodyapplication/jsonrequired

namestringrequired

Name of the group to create

descriptionstring

custom_dataobject

Group custom data object

curl -i -X POST \
  https://api.sbx.transmitsecurity.io/cis/v1/groups \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "string",
    "description": "string",
    "custom_data": {}
  }'

Responses

Bodyapplication/json

resultobjectrequired

result.group_idstringrequired

Group ID

result.namestringrequired

Group name

result.descriptionstring

Group description

result.created_atnumberrequired

Date group was created in the tenant

result.updated_atnumberrequired

Date group was last updated

result.custom_dataobject

Group custom data object

Response

application/json

{
  "result": {
    "group_id": "string",
    "name": "string",
    "description": "string",
    "created_at": 0,
    "updated_at": 0,
    "custom_data": {}
  }
}

Get groups

Request

Retrieve a list of all groups.

Required permissions: apps:read, [appId]:read, groups:read, apps:list, [appId]:list, groups:list.

Security

ClientAccessToken

curl -i -X GET \
  https://api.sbx.transmitsecurity.io/cis/v1/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[].created_atnumberrequired

Date group was created in the tenant

result[].updated_atnumberrequired

Date group was last updated

result[].custom_dataobject

Group custom data object

Response

application/json

{
  "result": [
    { … }
  ]
}

Get group by ID

Request

Retrieve a group by ID.

Required permissions: apps:read, [appId]:read, groups:read.

Security

ClientAccessToken

Path

group_idstringrequired

ID of the group to retrieve

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

Responses

Bodyapplication/json

resultobjectrequired

result.group_idstringrequired

Group ID

result.namestringrequired

Group name

result.descriptionstring

Group description

result.created_atnumberrequired

Date group was created in the tenant

result.updated_atnumberrequired

Date group was last updated

result.custom_dataobject

Group custom data object

Response

application/json

{
  "result": {
    "group_id": "string",
    "name": "string",
    "description": "string",
    "created_at": 0,
    "updated_at": 0,
    "custom_data": {}
  }
}

Update group

Request

Update a group for your users. Note: Fields that are objects cannot be partially updated, since the new value you set will just replace the current one.

Required permissions: apps:edit, [appId]:edit, groups:edit.

Security

ClientAccessToken

Path

group_idstringrequired

The ID of the group that should be updated

Bodyapplication/jsonrequired

namestring

Name of the group to update

descriptionstring

custom_dataobject

Group custom data object

curl -i -X PUT \
  'https://api.sbx.transmitsecurity.io/cis/v1/groups/{group_id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "string",
    "description": "string",
    "custom_data": {}
  }'

Responses

Bodyapplication/json

resultobjectrequired

result.group_idstringrequired

Group ID

result.namestringrequired

Group name

result.descriptionstring

Group description

result.created_atnumberrequired

Date group was created in the tenant

result.updated_atnumberrequired

Date group was last updated

result.custom_dataobject

Group custom data object

Response

application/json

{
  "result": {
    "group_id": "string",
    "name": "string",
    "description": "string",
    "created_at": 0,
    "updated_at": 0,
    "custom_data": {}
  }
}

Delete group

Request

Delete a group.

Required permissions: apps:delete, [appId]:delete, groups:delete.

Security

ClientAccessToken

Path

group_idstringrequired

ID of the group to delete

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

Responses

Group removed.

Response

No content

Add users to group

Request

Add one or more users as members of a group.

Required permissions: apps:edit, [appId]:edit, groups:edit.

Security

ClientAccessToken

Path

group_idstringrequired

ID of the group to assign the users to

Bodyapplication/jsonrequired

user_idsArray of stringsrequired

ID of the users to assign to the group

curl -i -X POST \
  'https://api.sbx.transmitsecurity.io/cis/v1/groups/{group_id}/members' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "user_ids": [
      "string"
    ]
  }'

Responses

Assigned users to group.

Response

No content

Get group's users

Request

Retrieve all users that are members of a specific group.

Required permissions: apps:read, [appId]:read, users:read.

Security

ClientAccessToken

Path

group_idstringrequired

ID of the group to retrieve users for

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

Responses

Bodyapplication/json

resultArray of objectsrequired

result[].emailobject

result[].secondary_emailsArray of objects

result[].phone_numberobject

result[].secondary_phone_numbersArray of objects

result[].usernamestring

Username used to identify the user for password login (unless a primary email will be used instead). Defined only if a password was set for the user.

result[].user_idstringrequired

User ID autogenerated upon user creation

result[].birthdaystring(date-time)

Birthday as YYYY-MM-DD

result[].addressobject

result[].nameobject

result[].statusstringrequired

Enum"Active""Disabled""Pending"

result[].status_changed_atstring(date-time)

Date status was last updated

result[].created_atnumberrequired

Date user was created in the tenant

result[].updated_atnumberrequired

Date user was last updated

result[].identitiesArray of objects

result[].last_authstring(date-time)

Date user last authenticated

result[].external_account_idstring

User identifier in an app, set by the app

result[].app_namestring

Name of the app the user is associated with

result[].custom_app_dataobject

Custom data object for app-related user info

result[].groupIdsArray of strings

List of group IDs the user is assigned to

result[].picturestring

The picture of user, specified as a URL

result[].languagestring

The language of the user, as provided by the browser using the Accept-Language header field

result[].custom_dataobject

Custom data object for tenant user info

result[].external_user_idstring

A unique identifier in a tenant

result[].password_informationobject

result[].identity_providersArray of objectsDeprecated

Response

application/json

{
  "result": [
    { … }
  ]
}

Remove user from group

Request

Remove a user from a group.

Required permissions: apps:edit, [appId]:edit, groups:edit.

Security

ClientAccessToken

Path

group_idstringrequired

Group ID

user_idstringrequired

User ID

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

Responses

Removed user from group.

Response

No content