Members

Set member's roles

Request

Update the roles of a member of the organization to control their access to an application. This will replace all the member's roles, if they exist. The roles must first be created for the application and added to a role group for the application, and the role group must be added to the organization.

Required permissions: organizations:edit, orgs:edit.

Security

AdminAccessToken

Path

app_idstringrequired

ID of the application to assign the roles to

organization_idstringrequired

ID of the organization to assign the roles to

member_idstringrequired

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}/organizations/{organization_id}/members/{member_id}/roles' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "role_ids": [
      "role1",
      "role2"
    ]
  }'

Responses

Get member's roles

Request

Get member's roles in app per organization

Security

ClientAccessToken

Path

member_idstringrequired

ID of the member

Query

organization_idstring

curl -i -X GET \
  'https://api.sbx.transmitsecurity.io/cis/v1/members/{member_id}/organizations?organization_id=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Bodyapplication/json

resultobjectrequired

Response

application/json

{
  "result": {}
}

Get member by ID

Request

Allows an end-user app to search for a member of an organization by their user ID. This should be called from the backend, using a client access token (generated by an end-user app).

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

Security

OrgAdminAccessToken or ClientAccessToken

Path

organization_idstringrequired

ID of the organization

user_idstringrequired

ID of the user

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

Responses

Bodyapplication/json

resultobjectrequired

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.organization_informationobjectrequired

result.organization_information.organization_idstringrequired

The organizationId

result.organization_information.namestringrequired

The organization name

result.organization_information.added_bystringrequired

The ID of who added this user

result.organization_information.departmentstring

The department of the user within the organization

result.organization_information.titlestring

The title of the user within the organization

result.organization_information.managerstring

The manager of the user within the organization

result.organization_information.enabledboolean

Indicates if the user's membership is currently enabled

result.organization_information.added_atnumber

The time when the member was added to the organization

result.organization_information.updated_atnumber

The time when the member was last updated in the organization

result.organization_information.logo_urlstring

The URL of the organization's logo

result.organization_information.aliasstring

The organization alias name

result.organization_information.assigned_appsArray of objects

The app id and roles that the user is assigned to on the organization

result.rolesArray of objects

The roles the member has in the organization

result.identity_providersArray of objectsDeprecated

Response

application/json

{
  "result": {
    "email": { … },
    "secondary_emails": [ … ],
    "phone_number": { … },
    "secondary_phone_numbers": [ … ],
    "username": "string",
    "user_id": "string",
    "birthday": "2019-08-24T14:15:22Z",
    "address": { … },
    "name": { … },
    "status": "Active",
    "status_changed_at": "2019-08-24T14:15:22Z",
    "created_at": 0,
    "updated_at": 0,
    "identity_providers": [ … ],
    "identities": [ … ],
    "last_auth": "2019-08-24T14:15:22Z",
    "external_account_id": "string",
    "app_name": "string",
    "custom_app_data": {},
    "groupIds": [ … ],
    "picture": "string",
    "language": "string",
    "custom_data": {},
    "external_user_id": "string",
    "password_information": { … },
    "organization_information": { … },
    "roles": [ … ]
  }
}

Update member

Request

Update the membership details of the specified user. This should be called from the backend, using an admin access token (generated by a management app).

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

Security

OrgAdminAccessToken or ClientAccessToken

Path

organization_idstringrequired

ID of the organization

user_idstringrequired

ID of the user

Bodyapplication/jsonrequired

enabledboolean

Indicates if the user's membership is currently enabled

Default true

departmentstring

The department of the user within the organization

titlestring

The title of the user within the organization

managerstring

The manager of the user within the organization

curl -i -X PUT \
  'https://api.sbx.transmitsecurity.io/cis/v1/organizations/{organization_id}/members/{user_id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "enabled": true,
    "department": "string",
    "title": "string",
    "manager": "string"
  }'

Responses

Bodyapplication/json

resultobjectread-onlyrequired

result.user_idstringrequired

ID of the user

Response

application/json

{
  "result": {
    "user_id": "string"
  }
}

Update member

Request

Update the member details of the specified user. This should be called from the backend, using an admin access token (generated by a management app).

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

Security

OrgAdminAccessToken or ClientAccessToken

Path

organization_idstringrequired

ID of the organization

user_idstringrequired

ID of the user

Bodyapplication/jsonrequired

nameobject

emailstring

Primary email address of the user

phone_numberstring

Primary phone number of the user, specified in E.164 format

languagestring

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

curl -i -X PATCH \
  'https://api.sbx.transmitsecurity.io/cis/v1/organizations/{organization_id}/members/{user_id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": {
      "title": "string",
      "first_name": "string",
      "last_name": "string",
      "middle_name": "string"
    },
    "email": "string",
    "phone_number": "string",
    "language": "string"
  }'

Responses

Remove member from application

Request

Remove a member from an application. Once removed, the member will no longer be associated with the application. This should be called from the backend, using an app access token.

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

Security

OrgAdminAccessToken or ClientAccessToken

Path

organization_idstringrequired

ID of the organization

user_idstringrequired

ID of the user to remove

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

Responses

Create or assign member

Request

Create a new user in Transmit or assign an existing one as a member to the organization. A user must be created with at least one of the following: email, phone number, or username (used for password authentication). However, an email address is required to federate login using a SAML identity provider. The response contains a user ID that can be used to identify the user/member whenever needed.

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

Security

OrgAdminAccessToken or ClientAccessToken

Path

organization_idstringrequired

ID of the organization

Bodyapplication/jsonrequired

emailstring

Primary email address of the user

phone_numberstring

Primary phone number of the user, specified in E.164 format

usernamestring

Username used to identify the user

secondary_emailsArray of strings

Secondary email addresses to add to user's current emails

secondary_phone_numbersArray of strings

Secondary phone numbers to add to user's phone numbers, each specified in E.164 format

birthdaystring(date-time)

User's birthday

addressobject

nameobject

external_account_idstring

User identifier in an app, set by the app

custom_app_dataobject

Custom data object for app-related user info

picturestring

The picture of user, specified as a URL

languagestring

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

custom_dataobject

Custom data object for tenant user info

external_user_idstring

A unique identifier in a tenant

credentialsobject

delegated_accessobject

organization_informationobject

role_idsArray of stringsrequired

role ids to assign the member to.

send_inviteboolean

If true, sends the member an invitation email for each app the member is assigned to. The email contains an invite link that redirects to the app's login experience. Once authenticated, the member will be assigned to the app, their email address will be verified, and their status will be updated to active. The invitation is valid for 48 hours.

curl -i -X POST \
  'https://api.sbx.transmitsecurity.io/cis/v1/organizations/{organization_id}/members' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "email": "string",
    "phone_number": "string",
    "username": "string",
    "secondary_emails": [
      "string"
    ],
    "secondary_phone_numbers": [
      "string"
    ],
    "birthday": "2019-08-24T14:15:22Z",
    "address": {
      "country": "string",
      "state": "string",
      "city": "string",
      "street_address": "string",
      "postal_code": "string",
      "type": "Home"
    },
    "name": {
      "title": "string",
      "first_name": "string",
      "last_name": "string",
      "middle_name": "string"
    },
    "external_account_id": "string",
    "custom_app_data": {},
    "picture": "string",
    "language": "string",
    "custom_data": {},
    "external_user_id": "string",
    "credentials": {
      "password": "string",
      "force_replace": true
    },
    "delegated_access": {
      "actor_id": "string",
      "permissions": [
        "string"
      ]
    },
    "organization_information": {
      "enabled": true,
      "department": "string",
      "title": "string",
      "manager": "string"
    },
    "role_ids": [
      "string"
    ],
    "send_invite": true
  }'

Responses

Bodyapplication/json

resultobjectread-onlyrequired

result.user_idstringrequired

ID of the user

Response

application/json

{
  "result": {
    "user_id": "string"
  }
}

Get all application's members

Request

Allows an app to get all members of an organization. This should be called from the backend, using a client access token (generated by an end-user app).

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

Security

OrgAdminAccessToken or ClientAccessToken

Path

organization_idstringrequired

ID of the organization

Query

searchstring

Search expression based on the SCIM protocol. For syntax and searchable fields, see Search query syntax

role_valuesArray of strings

curl -i -X GET \
  'https://api.sbx.transmitsecurity.io/cis/v1/organizations/{organization_id}/members?search=string&role_values=string' \
  -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[].organization_informationobjectrequired

result[].organization_information.organization_idstringrequired

The organizationId

result[].organization_information.namestringrequired

The organization name

result[].organization_information.added_bystringrequired

The ID of who added this user

result[].organization_information.departmentstring

The department of the user within the organization

result[].organization_information.titlestring

The title of the user within the organization

result[].organization_information.managerstring

The manager of the user within the organization

result[].organization_information.enabledboolean

Indicates if the user's membership is currently enabled

result[].organization_information.added_atnumber

The time when the member was added to the organization

result[].organization_information.updated_atnumber

The time when the member was last updated in the organization

result[].organization_information.logo_urlstring

The URL of the organization's logo

result[].organization_information.aliasstring

The organization alias name

result[].organization_information.assigned_appsArray of objects

The app id and roles that the user is assigned to on the organization

result[].rolesArray of objects

The roles the member has in the organization

result[].identity_providersArray of objectsDeprecated

Response

application/json

{
  "result": [
    { … }
  ]
}

Members

Set member's roles

Request

Responses

Get member's roles

Request

Responses

Get member by ID

Request

Responses

Update member

Request

Responses

Update member

RequestExpand all

Responses

Remove member from application

Request

Responses

Create or assign member

RequestExpand all

Responses

Get all application's members

Request

Responses

Request

Request