Create multiple users
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 If this user is a dependent, this defines the permissions that the primary user will have to act on behalf of the dependent user. |
[- {
- "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",
- "delegated_access": {
- "actor_id": "string",
- "permissions": [
- "string"
]
}
}
]
{- "result": {
- "total_users": 0,
- "created_user_ids": [
- "string"
], - "errors": [
- {
- "errors": [
- "string"
], - "user_identifier": "string"
}
]
}
}
Delete a user and all their data (tenant-level and app-level). Requires an admin access token (from a management app).
User deleted
curl -i -X DELETE \ 'https://api.transmitsecurity.io/cis/v1/manage/users/{user_id}' \ -H 'Authorization: Bearer <YOUR_JWT_HERE>'
{- "message": "string",
- "error_code": 404
}
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.
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. |
{- "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"
]
}
}
{- "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
}
}
}
Search across your users at Transmit. This endpoint also allows you to return all of your users by sending no filters at all
page_offset | number Number of users you wish to skip before selecting users |
page_limit | number <= 10000 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 |
sort_order | string The order of the sort |
search | string Search expression based on the SCIM protocol. For syntax and searchable fields, see Search query syntax |
curl -i -X GET \ 'https://api.transmitsecurity.io/cis/v1/users?page_offset=0&page_limit=10000&search_prefix=string&sort_field=email&sort_order=asc&search=string' \ -H 'Authorization: Bearer <YOUR_JWT_HERE>'
{- "total_count": 0,
- "page_info": {
- "has_next_page": true,
- "has_previous_page": true
}, - "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
}
}
]
}
curl -i -X GET \ 'https://api.transmitsecurity.io/cis/v1/users/count?status=Active' \ -H 'Authorization: Bearer <YOUR_JWT_HERE>'
{- "result": {
- "user_count": 0
}
}
curl -i -X GET \ 'https://api.transmitsecurity.io/cis/v1/users/email/{email}' \ -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
}
}
}
Search for a user by external_account_id
curl -i -X GET \ 'https://api.transmitsecurity.io/cis/v1/users/external-account-id/{external_account_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
}
}
}
Allows a logged-in user to register their first password. Must be authorized using a valid user access token returned upon successful authentication.
{- "password": "string",
- "force_replace": true,
- "username": "string"
}
{- "result": {
- "message": "Password registered"
}
}
Search for a user by their primary phone number
curl -i -X GET \ 'https://api.transmitsecurity.io/cis/v1/users/phone-number/{phone_number}' \ -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
}
}
}
Search for a user by their primary phone number
curl -i -X GET \ 'https://api.transmitsecurity.io/cis/v1/users/phone/{phone_number}' \ -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
}
}
}
curl -i -X GET \ 'https://api.transmitsecurity.io/cis/v1/users/username/{username}' \ -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
}
}
}
curl -i -X GET \ 'https://api.transmitsecurity.io/cis/v1/users/{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
}
}
}
Update a user's attributes
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 |
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 |
username | string Username used to identify the user for password login (unless a primary email will be used instead). Can only be updated if there’s a password set for this user. |
{- "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"
}, - "status": "Active",
- "external_account_id": "string",
- "custom_app_data": { },
- "picture": "string",
- "language": "string",
- "custom_data": { },
- "external_user_id": "string",
- "username": "string"
}
{- "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
}
}
}
Remove a user from the requesting application
User removed
curl -i -X DELETE \ 'https://api.transmitsecurity.io/cis/v1/users/{user_id}/apps' \ -H 'Authorization: Bearer <YOUR_JWT_HERE>'
{- "message": "Bad request",
- "error_code": 400
}
Removes a secondary email address from the user's profile
Secondary email is removed
curl -i -X DELETE \ 'https://api.transmitsecurity.io/cis/v1/users/{user_id}/emails/{email}' \ -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Retrieve a list of groups associated with a user
curl -i -X GET \ 'https://api.transmitsecurity.io/cis/v1/users/{user_id}/groups' \ -H 'Authorization: Bearer <YOUR_JWT_HERE>'
{- "result": [
- {
- "group_id": "string",
- "name": "string",
- "description": "string",
- "created_at": 0,
- "updated_at": 0,
- "custom_data": { }
}
]
}
Creates new password credentials for a user that doesn't already have a password. The password is temporary, and must be reset upon the user's first login.
{- "password": "string",
- "force_replace": true,
- "username": "string"
}
{- "result": {
- "message": "Password registered"
}
}
Updates the user's existing credentials with a new temporary password, which must be reset the next time they login.
{- "password": "string",
- "force_replace": true
}
{- "result": {
- "message": "Password registered"
}
}
Remove a secondary phone number from the user's profile
Secondary phone number is removed
curl -i -X DELETE \ 'https://api.transmitsecurity.io/cis/v1/users/{user_id}/phone-numbers/{phone_number}' \ -H 'Authorization: Bearer <YOUR_JWT_HERE>'