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 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).
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 |
{- "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"
]
}, - "organization_information": {
- "enabled": true,
- "department": "string",
- "title": "string",
- "manager": "string",
- "app_ids": [
- "string"
]
}
}
{- "result": {
- "user_id": "string"
}
}
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).
curl -i -X GET \ 'https://api.transmitsecurity.io/cis/v1/organizations/{organization_id}/members' \ -H 'Authorization: Bearer <YOUR_JWT_HERE>'
{- "result": [
- {
- "email": {
- "value": "string",
- "email_verified": true,
- "verified_at": "2019-08-24T14:15:22Z"
}, - "secondary_emails": [
- {
- "value": "string",
- "email_verified": true,
- "verified_at": "2019-08-24T14:15:22Z"
}
], - "phone_number": {
- "value": "string",
- "phone_number_verified": true,
- "verified_at": "2019-08-24T14:15:22Z"
}, - "secondary_phone_numbers": [
- {
- "value": "string",
- "phone_number_verified": true,
- "verified_at": "2019-08-24T14:15:22Z"
}
], - "username": "string",
- "user_id": "string",
- "birthday": "2019-08-24T14:15:22Z",
- "address": {
- "country": "string",
- "state": "string",
- "city": "string",
- "street_address": "string",
- "postal_code": "string",
- "type": "Home",
- "updated_at": 0
}, - "name": {
- "title": "string",
- "first_name": "string",
- "last_name": "string",
- "middle_name": "string"
}, - "status": "Active",
- "created_at": 0,
- "updated_at": 0,
- "identity_providers": [
- {
- "source": "UserID",
- "identifier": "string",
- "email": "string",
- "first_auth_date": "2019-08-24T14:15:22Z",
- "last_auth_date": "2019-08-24T14:15:22Z"
}
], - "identities": [
- {
- "provider_name": "string",
- "provider_type": "OAuth2",
- "auth_type": "webauthn",
- "identifier": "string",
- "user_alias": {
- "type": "username",
- "value": "string"
}, - "first_auth_date": "2019-08-24T14:15:22Z",
- "last_auth_date": "2019-08-24T14:15:22Z"
}
], - "last_auth": "2019-08-24T14:15:22Z",
- "external_account_id": "string",
- "app_name": "string",
- "custom_app_data": { },
- "groupIds": [
- "string"
], - "picture": "string",
- "language": "string",
- "custom_data": { },
- "external_user_id": "string",
- "password_information": {
- "expired": true,
- "temporary": true,
- "updated_at": 0
}, - "organization_information": {
- "organization_id": "string",
- "added_by": "string",
- "enabled": true,
- "department": "string",
- "title": "string",
- "manager": "string",
- "added_at": 0,
- "updated_at": 0
}, - "app_data": [
- {
- "app_id": "string",
- "external_account_id": "string",
- "custom_app_data": { },
- "app_name": "string",
- "username": "string",
- "password_information": {
- "expired": true,
- "temporary": true,
- "updated_at": 0
}
}
]
}
]
}
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).
Member has been assigned to app
{- "enabled": true,
- "department": "string",
- "title": "string",
- "manager": "string",
- "app_ids": [
- "string"
]
}
{- "message": "Bad request",
- "error_code": 400
}
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).
curl -i -X GET \ 'https://api.transmitsecurity.io/cis/v1/organizations/{organization_id}/members/{user_id}' \ -H 'Authorization: Bearer <YOUR_JWT_HERE>'
{- "result": {
- "email": {
- "value": "string",
- "email_verified": true,
- "verified_at": "2019-08-24T14:15:22Z"
}, - "secondary_emails": [
- {
- "value": "string",
- "email_verified": true,
- "verified_at": "2019-08-24T14:15:22Z"
}
], - "phone_number": {
- "value": "string",
- "phone_number_verified": true,
- "verified_at": "2019-08-24T14:15:22Z"
}, - "secondary_phone_numbers": [
- {
- "value": "string",
- "phone_number_verified": true,
- "verified_at": "2019-08-24T14:15:22Z"
}
], - "username": "string",
- "user_id": "string",
- "birthday": "2019-08-24T14:15:22Z",
- "address": {
- "country": "string",
- "state": "string",
- "city": "string",
- "street_address": "string",
- "postal_code": "string",
- "type": "Home",
- "updated_at": 0
}, - "name": {
- "title": "string",
- "first_name": "string",
- "last_name": "string",
- "middle_name": "string"
}, - "status": "Active",
- "created_at": 0,
- "updated_at": 0,
- "identity_providers": [
- {
- "source": "UserID",
- "identifier": "string",
- "email": "string",
- "first_auth_date": "2019-08-24T14:15:22Z",
- "last_auth_date": "2019-08-24T14:15:22Z"
}
], - "identities": [
- {
- "provider_name": "string",
- "provider_type": "OAuth2",
- "auth_type": "webauthn",
- "identifier": "string",
- "user_alias": {
- "type": "username",
- "value": "string"
}, - "first_auth_date": "2019-08-24T14:15:22Z",
- "last_auth_date": "2019-08-24T14:15:22Z"
}
], - "last_auth": "2019-08-24T14:15:22Z",
- "external_account_id": "string",
- "app_name": "string",
- "custom_app_data": { },
- "groupIds": [
- "string"
], - "picture": "string",
- "language": "string",
- "custom_data": { },
- "external_user_id": "string",
- "password_information": {
- "expired": true,
- "temporary": true,
- "updated_at": 0
}, - "organization_information": {
- "organization_id": "string",
- "added_by": "string",
- "enabled": true,
- "department": "string",
- "title": "string",
- "manager": "string",
- "added_at": 0,
- "updated_at": 0
}
}
}
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).
{- "enabled": true,
- "department": "string",
- "title": "string",
- "manager": "string"
}
{- "result": {
- "user_id": "string"
}
}
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).
curl -i -X DELETE \ 'https://api.transmitsecurity.io/cis/v1/organizations/{organization_id}/members/{user_id}' \ -H 'Authorization: Bearer <YOUR_JWT_HERE>'
{- "message": "Bad request",
- "error_code": 400
}