Users

Download OpenAPI specification:Download

Manage user profiles

Create users

Create multiple users

SecurityHTTP: bearer
Request
Request Body schema: application/json
Array
email
string

Primary email address of the user

phone_number
string

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

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

Responses
201
400
post/v1/users/bulk
Request samples
application/json
[
  • {
    }
]
Response samples
application/json
{
  • "result": {
    }
}

Create user

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.

SecurityHTTP: bearer
Request
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

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

Responses
201
400
409
post/v1/users
Request samples
application/json
{
  • "email": "string",
  • "phone_number": "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"
}
Response samples
application/json
{
  • "result": {
    }
}

Get users

Search across your users at Transmit. This endpoint also allows you to return all of your users by sending no filters at all

SecurityHTTP: bearer
Request
query Parameters
page_offset
number

Number of users you wish to skip before selecting users

page_limit
number <= 1000

Number of users to return in page

search_prefix
string

Value to search for in the primary email and phone_number fields, where the search value must match the prefix of the field value. For example, "search_prefix=john" will return users whose email starts with "john" and "search_prefix=%2B1212" returns users whose phone number starts with "+1212".

Example: search_prefix=joe
sort_field
string

The name of the field you wish to sort by

Enum: "email" "created_at" "phone_number" "last_auth"
sort_order
string

The order of the sort

Enum: "asc" "desc"
search
string

Search expression based on the SCIM protocol. For syntax and searchable fields, see Search query syntax

Responses
200
400
get/v1/users
Request samples
curl -i -X GET \
  'https://api.userid.security/v1/users?page_offset=0&page_limit=1000&search_prefix=string&sort_field=email&sort_order=asc&search=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "total_count": 0,
  • "page_info": {
    },
  • "result": [
    ]
}

Get users count

Get the number of users saved in Transmit

SecurityHTTP: bearer
Request
query Parameters
status
string

Status of the users to count

Enum: "Active" "Disabled" "Pending" "Forget Requested"
Responses
200
400
get/v1/users/count
Request samples
curl -i -X GET \
  'https://api.userid.security/v1/users/count?status=Active' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "result": {
    }
}

Get user by email

Search for a user by primary email

SecurityHTTP: bearer
Request
path Parameters
email
required
string

The user's primary email to search for

Responses
200
400
404
get/v1/users/email/{email}
Request samples
curl -i -X GET \
  'https://api.userid.security/v1/users/email/{email}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "result": {
    }
}

Get user by phone number

Search for a user by their primary phone number

SecurityHTTP: bearer
Request
path Parameters
phone_number
required
string

The phone number of the user to get

Responses
200
400
404
get/v1/users/phone/{phone_number}
Request samples
curl -i -X GET \
  'https://api.userid.security/v1/users/phone/{phone_number}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "result": {
    }
}

Get user by username

Search for a user by username

SecurityHTTP: bearer
Request
path Parameters
username
required
string

The user's username to search for

Responses
200
400
404
get/v1/users/username/{username}
Request samples
curl -i -X GET \
  'https://api.userid.security/v1/users/username/{username}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "result": {
    }
}

Get user by ID

Search for a user by user ID

SecurityHTTP: bearer
Request
path Parameters
user_id
required
string

The user ID to search for

Responses
200
400
404
get/v1/users/{user_id}
Request samples
curl -i -X GET \
  'https://api.userid.security/v1/users/{user_id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "result": {
    }
}

Update user

Update a user's attributes

SecurityHTTP: bearer
Request
path Parameters
user_id
required
string

The ID of the user that should be updated

Request Body schema: application/json
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

status
string

Status of user

Enum: "Active" "Disabled" "Pending" "Forget Requested"
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

Responses
200
400
404
put/v1/users/{user_id}
Request samples
application/json
{
  • "secondary_emails": [
    ],
  • "secondary_phone_numbers": [
    ],
  • "birthday": "2019-08-24T14:15:22Z",
  • "address": {
    },
  • "name": {
    },
  • "status": "Active",
  • "external_account_id": "string",
  • "custom_app_data": { },
  • "picture": "string",
  • "language": "string",
  • "custom_data": { },
  • "external_user_id": "string"
}
Response samples
application/json
{
  • "result": {
    }
}

Remove user from app

Remove a user from the requesting application

SecurityHTTP: bearer
Request
path Parameters
user_id
required
string

The ID of the user to remove from application

Responses
204

User removed

400
404
delete/v1/users/{user_id}/apps
Request samples
curl -i -X DELETE \
  'https://api.userid.security/v1/users/{user_id}/apps' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "message": "Bad request",
  • "error_code": 400
}

Get user's groups

Retrieve a list of groups associated with a user

SecurityHTTP: bearer
Request
path Parameters
user_id
required
string

ID of the user to retrieve groups for

Responses
200
400
404
get/v1/users/{user_id}/groups
Request samples
curl -i -X GET \
  'https://api.userid.security/v1/users/{user_id}/groups' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "result": [
    ]
}