Members

Download OpenAPI specification:Download

In business-to-business (B2B) use cases, members are the users of your business customers and partners (managed as organizations of the tenant).

Create member

Create a new user in Transmit and add them 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. This should be called from the backend, using an admin access token (generated by a management app).

SecurityHTTP: bearer
Request
path Parameters
organization_id
required
string

ID of the organization

Request Body schema: application/json
email
string

Primary email address of the user

phone_number
string

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

username
string

Username used to identify the user for password login (unless a primary email will be used instead). Assigning a username requires setting a password for the user.

secondary_emails
Array of strings

Secondary email addresses to add to user's current emails

secondary_phone_numbers
Array of strings

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

birthday
string <date-time>

User's birthday

object

User's address

object

Object describing user's full name

external_account_id
string

User identifier in an app, set by the app

custom_app_data
object

Custom data object for app-related user info

picture
string

The picture of user, specified as a URL

language
string

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

custom_data
object

Custom data object for tenant user info

external_user_id
string

A unique identifier in a tenant

object

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

object

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

required
object

Membership details

Responses
200
400
409
post/v1/organizations/{organization_id}/members
Request samples
application/json
{
  • "email": "string",
  • "phone_number": "string",
  • "username": "string",
  • "secondary_emails": [
    ],
  • "secondary_phone_numbers": [
    ],
  • "birthday": "2019-08-24T14:15:22Z",
  • "address": {
    },
  • "name": {
    },
  • "external_account_id": "string",
  • "custom_app_data": { },
  • "picture": "string",
  • "language": "string",
  • "custom_data": { },
  • "external_user_id": "string",
  • "credentials": {
    },
  • "delegated_access": {
    },
  • "organization_information": {
    }
}
Response samples
application/json
{
  • "result": {
    }
}

Get all members

Search for all users that are members of the organization. This should be called from the backend, using an admin access token (generated by a management app).

SecurityHTTP: bearer
Request
path Parameters
organization_id
required
string

ID of the organization

Responses
200
get/v1/organizations/{organization_id}/members
Request samples
curl -i -X GET \
  'https://api.transmitsecurity.io/cis/v1/organizations/{organization_id}/members' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "result": [
    ]
}

Add member

Add an existing Transmit user as a member of the organization. To federate login using a SAML identity provider, the user must have a primary email address with the organization's domain. This should be called from the backend, using an admin access token (generated by a management app).

SecurityHTTP: bearer
Request
path Parameters
organization_id
required
string

ID of the organization

user_id
required
string

ID of the user

Request Body schema: application/json
enabled
boolean
Default: true

Indicates if the user's membership is currently enabled

department
string

The department of the user within the organization

title
string

The title of the user within the organization

manager
string

The manager of the user within the organization

app_ids
required
Array of strings

List of applications to add the user to

Responses
204

Member has been assigned to app

400
404
post/v1/organizations/{organization_id}/members/{user_id}
Request samples
application/json
{
  • "enabled": true,
  • "department": "string",
  • "title": "string",
  • "manager": "string",
  • "app_ids": [
    ]
}
Response samples
application/json
{
  • "message": "Bad request",
  • "error_code": 400
}

Get member by ID

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

SecurityHTTP: bearer
Request
path Parameters
organization_id
required
string

ID of the organization

user_id
required
string

ID of the user

Responses
200
400
404
get/v1/organizations/{organization_id}/members/{user_id}
Request samples
curl -i -X GET \
  'https://api.transmitsecurity.io/cis/v1/organizations/{organization_id}/members/{user_id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "result": {
    }
}

Update member

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

SecurityHTTP: bearer
Request
path Parameters
organization_id
required
string

ID of the organization

user_id
required
string

ID of the user

Request Body schema: application/json
enabled
boolean
Default: true

Indicates if the user's membership is currently enabled

department
string

The department of the user within the organization

title
string

The title of the user within the organization

manager
string

The manager of the user within the organization

Responses
200
400
404
put/v1/organizations/{organization_id}/members/{user_id}
Request samples
application/json
{
  • "enabled": true,
  • "department": "string",
  • "title": "string",
  • "manager": "string"
}
Response samples
application/json
{
  • "result": {
    }
}

Remove member

Remove a user from an organization. Once removed, the user will still exist in the tenant but will no longer be associated with the organization. This should be called from the backend, using an admin access token (generated by a management app).

SecurityHTTP: bearer
Request
path Parameters
organization_id
required
string

ID of the organization

user_id
required
string

ID of the user to remove

Responses
204
400
404
delete/v1/organizations/{organization_id}/members/{user_id}
Request samples
curl -i -X DELETE \
  'https://api.transmitsecurity.io/cis/v1/organizations/{organization_id}/members/{user_id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "message": "Bad request",
  • "error_code": 400
}