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

Set member's roles

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.

SecurityHTTP: bearer
Request
path Parameters
app_id
required
string

ID of the application to assign the roles to

organization_id
required
string

ID of the organization to assign the roles to

member_id
required
string
Request Body schema: application/json
required
role_ids
required
Array of strings

Ids of the roles

Responses
204
post/v1/applications/{app_id}/organizations/{organization_id}/members/{member_id}/roles
Request samples
application/json
{
  • "role_ids": [
    ]
}

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
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
required
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
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 from application

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.

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
delete/v1/organizations/{organization_id}/members/{user_id}
Request samples

Create or assign member

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

object

Membership details

role_ids
required
Array of strings

role ids to assign the member to.

send_invite
boolean

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.

Responses
200
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": {
    },
  • "role_ids": [
    ],
  • "send_invite": true
}
Response samples
application/json
{
  • "result": {
    }
}

Get all application's members

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

SecurityHTTP: bearer
Request
path Parameters
organization_id
required
string

ID of the organization

Responses
200
get/v1/organizations/{organization_id}/members
Request samples
Response samples
application/json
{
  • "result": [
    ]
}