Get users count

Request

Get the number of saved users.

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

Security

ClientAccessToken

Query

searchstring

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

curl -i -X GET \
  'https://api.sbx.transmitsecurity.io/cis/v1/users/count?search=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Bodyapplication/json

resultobjectrequired

result.user_countnumberrequired

Number of users

Response

application/json

{
  "result": {
    "user_count": 0
  }
}

Create user

Request

Add a user to Transmit. A user_id is returned as part of the User in the response that can then be used to perform other operations, such as get, update and delete. An email or a phone_number are required.

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

Security

ClientAccessToken

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

curl -i -X POST \
  https://api.sbx.transmitsecurity.io/cis/v1/users \
  -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"
      ]
    }
  }'

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.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": { … }
  }
}

Get users

Request

Search across your application’s users at Transmit. This endpoint also allows you to return all of your application’s users by sending no filters at all.

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

Security

ClientAccessToken

Query

searchstring

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

page_offsetnumber

Number of users you wish to skip before selecting users

page_limitnumber<= 10000

Number of users to return in page

search_prefixstring

Value to search for in the primary email and phone_number fields, where the search value must match the prefix of the field value. For example, "search_prefix=john" will return users whose email starts with "john" and "search_prefix=%2B1212" returns users whose phone number starts with "+1212".

Example: search_prefix=joe

sort_fieldstring

The name of the field you wish to sort by

Default "created_at"

Enum"email""created_at""phone_number""last_auth"

sort_orderstring

The order of the sort

Default "asc"

Enum"asc""desc"

curl -i -X GET \
  'https://api.sbx.transmitsecurity.io/cis/v1/users?search=string&page_offset=0&page_limit=10000&search_prefix=joe&sort_field=email&sort_order=asc' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Bodyapplication/json

total_countnumberrequired

page_infoobjectrequired

page_info.has_next_pagebooleanrequired

page_info.has_previous_pagebooleanrequired

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

{
  "total_count": 0,
  "page_info": {
    "has_next_page": true,
    "has_previous_page": true
  },
  "result": [
    { … }
  ]
}

Get user by identifier

Request

Search for a user by identifier.

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

Security

ClientAccessToken

Path

emailstringrequired

The user's primary email to search for

Query

identifier_namestringrequired

Identifier name: one of the built-ins (email, phoneNumber, externalUserId, username, idpIdentifier) or a tenant-defined custom identifier

identifier_valuestringrequired

Identifier value

curl -i -X GET \
  'https://api.sbx.transmitsecurity.io/cis/v1/users/identifier?identifier_name=string&identifier_value=string' \
  -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.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": { … }
  }
}

Get user by ID

Request

Search for a user by user ID.

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

Security

ClientAccessToken

Path

user_idstringrequired

The user ID to search for

curl -i -X GET \
  'https://api.sbx.transmitsecurity.io/cis/v1/users/{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.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": { … }
  }
}

Update user

Request

Update a user's attributes or their custom data. Changes will be merged into the user's profile, so you can specify only the fields you want to update.

Note:

Attributes (like name and address) cannot be partially updated, as the new value of an object or array will just replace the current one.
custom_data can be partially updated since it will be merged with the existing data (as a shallow merge).

.

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

Security

ClientAccessToken

Path

user_idstringrequired

The ID of the user that should be updated

Headers

user-agentstring

Bodyapplication/jsonrequired

emailstring

Primary email address of the user

phone_numberstring

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

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

statusstring

Status of user

Enum"Active""Disabled""Pending"

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

usernamestring

Username used to identify the user for password login (unless a primary email will be used instead)

curl -i -X PUT \
  'https://api.sbx.transmitsecurity.io/cis/v1/users/{user_id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'user-agent: string' \
  -d '{
    "email": "string",
    "phone_number": "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"
    },
    "status": "Active",
    "external_account_id": "string",
    "custom_app_data": {},
    "picture": "string",
    "language": "string",
    "custom_data": {},
    "external_user_id": "string",
    "username": "string"
  }'

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.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": { … }
  }
}

Get user's groups

Request

Retrieve a list of groups associated with a user.

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

Security

ClientAccessToken

Path

user_idstringrequired

ID of the user to retrieve groups for

curl -i -X GET \
  'https://api.sbx.transmitsecurity.io/cis/v1/users/{user_id}/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 user by email

Request

Search for a user by primary email.

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

Security

ClientAccessToken

Path

emailstringrequired

The user's primary email to search for

curl -i -X GET \
  'https://api.sbx.transmitsecurity.io/cis/v1/users/email/{email}' \
  -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.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": { … }
  }
}

Get user by external user ID

Request

Search for a user by their external_user_id, which represents the user identifier in external provider.

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

Security

ClientAccessToken

Path

external_user_idstringrequired

The external user ID to search for

curl -i -X GET \
  'https://api.sbx.transmitsecurity.io/cis/v1/users/external-user-id/{external_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.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": { … }
  }
}

Get user by username

Request

Search for a user by username.

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

Security

ClientAccessToken

Path

usernamestringrequired

The user's username to search for

curl -i -X GET \
  'https://api.sbx.transmitsecurity.io/cis/v1/users/username/{username}' \
  -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.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": { … }
  }
}

Remove user from app

Request

Remove a user from the requesting application.

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

Security

ClientAccessToken

Path

user_idstringrequired

The ID of the user to remove from application

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

Responses

User removed

Response

No content

Create credentials

Request

Creates new password credentials for a user that doesn't already have a password. The password is temporary, and must be reset upon the user's first login.

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

Security

ClientAccessToken

Path

user_idstringrequired

The ID of the user

Bodyapplication/jsonrequired

passwordstringrequired

The user's new password

force_replaceboolean

When true the password is temporary and the user will be required to replace it upon successful login

Default true

usernamestring

The user's new username. This will be the identifier the user will use to authenticate. If username is not provided and the user has verified their email, that email address will be used as the username.

enforce_complexityboolean

If true, the password must meet the password complexity requirements. If false, the password can be any string.

Default true

curl -i -X POST \
  'https://api.sbx.transmitsecurity.io/cis/v1/users/{user_id}/password' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "password": "string",
    "force_replace": true,
    "username": "string",
    "enforce_complexity": true
  }'

Responses

Bodyapplication/json

resultobjectrequired

result.messagestringread-onlyrequired

Example: "Password registered"

Response

application/json

{
  "result": {
    "message": "Password registered"
  }
}

Update password

Request

Updates the user's existing credentials with a new temporary password, which must be reset the next time they login.

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

Security

ClientAccessToken

Path

user_idstringrequired

The ID of the user

Bodyapplication/jsonrequired

passwordstring

The user's new password

force_replaceboolean

When true the password is temporary and the user will be required to replace it upon successful login

Default true

curl -i -X PUT \
  'https://api.sbx.transmitsecurity.io/cis/v1/users/{user_id}/password' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "password": "string",
    "force_replace": true
  }'

Responses

Bodyapplication/json

resultobjectrequired

result.messagestringread-onlyrequired

Example: "Password registered"

Response

application/json

{
  "result": {
    "message": "Password registered"
  }
}

Get user by phone number

Request

Search for a user by their primary phone number.

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

Security

ClientAccessToken

Path

phone_numberstringrequired

The phone number of the user to get

curl -i -X GET \
  'https://api.sbx.transmitsecurity.io/cis/v1/users/phone-number/{phone_number}' \
  -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.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": { … }
  }
}

Remove secondary email

Request

Removes a secondary email address from the user's profile.

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

Security

ClientAccessToken

Path

emailstringrequired

Secondary email to remove

user_idstringrequired

ID of the user

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

Responses

Secondary email is removed

Remove secondary phone number

Request

Remove a secondary phone number from the user's profile.

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

Security

ClientAccessToken

Path

phone_numberstringrequired

Secondary phone number to remove

user_idstringrequired

ID of the user

curl -i -X DELETE \
  'https://api.sbx.transmitsecurity.io/cis/v1/users/{user_id}/phone-numbers/{phone_number}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Secondary phone number is removed

Mark email as verified

Request

Indicates that the user's email address was verified externally. A user's email address is automatically marked as verified when used in a Transmit authentication or verification flow. If the email address is a secondary email, the request can also be used to set it as the user's primary email (by setting change_to_primary to true).

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

Security

ClientAccessToken

Path

user_idstringrequired

The ID of the user that should be updated

emailstringrequired

The email of the user that should be verified

Bodyapplication/jsonrequired

change_to_primaryboolean

curl -i -X POST \
  'https://api.sbx.transmitsecurity.io/cis/v1/users/{user_id}/emails/{email}/verify' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "change_to_primary": true
  }'

Responses

User email has been verified

Response

No content

Mark phone as verified

Request

Indicates that the user's phone number was verified externally. A user's phone number is automatically marked as verified when used in a Transmit authentication or verification flow. If the phone number is a secondary one, the request can also be used to set it as the user's primary phone (by setting change_to_primary to true).

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

Security

ClientAccessToken

Path

phone_numberstringrequired

The phone number of the user that should be verified

user_idstringrequired

The ID of the user that should be updated

Bodyapplication/jsonrequired

change_to_primaryboolean

curl -i -X POST \
  'https://api.sbx.transmitsecurity.io/cis/v1/users/{user_id}/phone-numbers/{phone_number}/verify' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "change_to_primary": true
  }'

Responses

User phone number has been verified

Response

No content

Delete user

Request

Delete a user and all their data (tenant-level and app-level). Requires an admin access token (from a management app).

Required permissions: users:delete.

Security

bearer

Path

user_idstringrequired

ID of the user

curl -i -X DELETE \
  'https://api.sbx.transmitsecurity.io/cis/v1/manage/users/{user_id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

User deleted

Response

No content

Register password

Request

Allows a logged-in user to register their first password. Must be authorized using a valid user access token returned upon successful authentication.

Security

UserAccessToken

Bodyapplication/jsonrequired

passwordstringrequired

The user's new password

usernamestring

The user's new username. This will be the identifier the user will use to authenticate. If username is not provided and the user has verified their email, that email address will be used as the username.

curl -i -X POST \
  https://api.sbx.transmitsecurity.io/cis/v1/users/me/password-credentials \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "password": "string",
    "username": "string"
  }'

Responses

Bodyapplication/json

resultobjectrequired

result.messagestringread-onlyrequired

Example: "Password registered"

Response

application/json

{
  "result": {
    "message": "Password registered"
  }
}

Get current user's device keys

Request

Get device keys by user id

Security

UserAccessToken

curl -i -X GET \
  https://api.sbx.transmitsecurity.io/cis/v1/users/me/device-keys \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Bodyapplication/json

resultobjectrequired

result.statusstringrequired

Enum"Active""Blocked""Suspended"

result.display_namestring

Friendly device name, used when displaying a list of the user's devices

result.custom_dataobject

Custom data stored for this device, such as tags or device data obtained using other tools

result.push_configobject

result.key_idstring

Identifier of the user's device

result.created_atstring(date-time)required

Date the device key was added

result.updated_atstring(date-time)required

Date the device key metadata was last updated

Response

application/json

{
  "result": {
    "status": "Active",
    "display_name": "string",
    "custom_data": {},
    "push_config": { … },
    "key_id": "string",
    "created_at": "2019-08-24T14:15:22Z",
    "updated_at": "2019-08-24T14:15:22Z"
  }
}

Get user by phone numberDeprecated

Request

Search for a user by their primary phone number

Security

ClientAccessToken

Path

phone_numberstringrequired

The phone number of the user to get

curl -i -X GET \
  'https://api.sbx.transmitsecurity.io/cis/v1/users/phone/{phone_number}' \
  -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.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": { … }
  }
}

Users

Get users count

Request

Responses

Create user

RequestExpand all

Responses

Get users

Request

Responses

Get user by identifier

Request

Responses

Get user by ID

Request

Responses

Update user

RequestExpand all

Responses

Get user's groups

Request

Responses

Get user by email

Request

Responses

Get user by external user ID

Request

Responses

Get user by username

Request

Responses

Remove user from app

Request

Responses

Create credentials

Request

Responses

Update password

Request

Responses

Get user by phone number

Request

Responses

Remove secondary email

Request

Responses

Remove secondary phone number

Request

Responses

Mark email as verified

Request

Responses

Mark phone as verified

Request

Responses

Delete user

Request

Responses

Register password

Request

Responses

Get current user's device keys

Request

Responses

Get user by phone numberDeprecated

Request

Responses

Request

Request