Skip to content

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

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

organization_informationobject

Membership details

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,
      "device_id": "string"
    },
    "delegated_access": {
      "actor_id": "string",
      "permissions": [
        "string"
      ]
    },
    "custom_user_fields": {},
    "organization_information": {
      "enabled": true,
      "department": "string",
      "title": "string",
      "manager": "string"
    },
    "role_ids": [
      "string"
    ],
    "send_invite": true
  }'

Responses

Bodyapplication/json
resultobjectread-onlyrequired

User ID autogenerated upon user creation

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