Skip to content

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

User's address

nameobject

Object describing user's full name

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

The password of the user, who is identified by either a username or primary email.

delegated_accessobject

If this user is a dependent, this defines the permissions that the primary user will have to act on behalf of the dependent user.

custom_user_fieldsobject

Custom user fields defined by the tenant schema

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,
      "device_id": "string"
    },
    "delegated_access": {
      "actor_id": "string",
      "permissions": [
        "string"
      ]
    },
    "custom_user_fields": {}
  }'

Responses

Bodyapplication/json
resultobjectrequired
Response
{
  "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": { … },
    "custom_user_fields": {}
  }
}