How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Transmit Security Users API

The Users API from Transmit Security — 18 operation(s) for users.

Transmit Security Users API is one of 9 APIs that Transmit Security publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 7 JSON Schema definitions.

Tagged areas include User. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and 7 JSON Schemas.

This API exposes 21 operations across 18 paths, and defines 33 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

Requests are made against 5 base URLs: https://api.sbx.transmitsecurity.io/cis, https://api.transmitsecurity.io/cis, https://api.eu.transmitsecurity.io/cis, https://api.ca.transmitsecurity.io/cis, https://api.au.transmitsecurity.io/cis.

21 operations 18 paths 33 schemas 3 DELETE11 GET5 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
Base URL
https://api.transmitsecurity.io
Authentication
HTTP Bearer, HTTP Bearer, OAuth 2.0, OAuth 2.0, OAuth 2.0
Resource Areas
1

Authentication & Security 5

Transmit Security Users API declares 5 security schemes for authenticating requests. It accepts HTTP bearer tokens (JWT) (bearer). It accepts HTTP bearer tokens (JWT) (UserAccessToken). It supports OAuth 2.0 (AdminAccessToken) using the clientCredentials flow. It supports OAuth 2.0 (ClientAccessToken) using the clientCredentials flow. It supports OAuth 2.0 (OrgAdminAccessToken) using the clientCredentials flow.

  • UserAccessToken — A token returned upon end-user authentication, which provides access to resources and data for the user and app for which it was generated
  • AdminAccessToken — A token generated by a management application using the [token endpoint](/openapi/token.openapi/other/getaccesstoken). It provides access to all resources for…
  • ClientAccessToken — A token generated by an end-user application using the [token endpoint](/openapi/token.openapi/other/getaccesstoken). It provides access to resources and data…
  • OrgAdminAccessToken — A token returned upon B2B authentication for a user that has the organizationAdmin or organizationCreator role.

Paths & Operations 21

Across 18 paths, the API surfaces 21 operations — 3 DELETE, 11 GET, 5 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

Users 21
GET
/v1/users/count
Get users count
getUsersCount 1 param → 200400
POST
/v1/users
Create user
createUser body → 201400409
GET
/v1/users
Get users
getUsers 6 params → 200400
GET
/v1/users/identifier
Get user by identifier
getUserByIdentifier 2 params → 200400404
GET
/v1/users/{user_id}
Get user by ID
getUserById 1 param → 200400404
PUT
/v1/users/{user_id}
Update user
updateUser 2 params body → 200400404
GET
/v1/users/{user_id}/groups
Get user's groups
getUserGroups 1 param → 200400404
GET
/v1/users/email/{email}
Get user by email
getUserByEmail 1 param → 200400404
GET
/v1/users/external-user-id/{external_user_id}
Get user by external user ID
getUserByExternalUserId 1 param → 200400404
GET
/v1/users/username/{username}
Get user by username
getUserByUsername 1 param → 200400404
DELETE
/v1/users/{user_id}/apps
Remove user from app
removeUserFromApp 1 param → 204400404
POST
/v1/users/{user_id}/password
Create credentials
addPasswordCredential 1 param body → 201400404409
PUT
/v1/users/{user_id}/password
Update password
updatePasswordCredential 1 param body → 200400404409
GET
/v1/users/phone/{phone_number}deprecated
Get user by phone number
deprecatedGetUserByPhone 1 param → 200400404
GET
/v1/users/phone-number/{phone_number}
Get user by phone number
getUserByPhone 1 param → 200400404
DELETE
/v1/users/{user_id}/emails/{email}
Remove secondary email
removeUserSecondaryEmail 2 params → 204400404
DELETE
/v1/users/{user_id}/phone-numbers/{phone_number}
Remove secondary phone number
removeUserSecondaryPhoneNumber 2 params → 204400404
POST
/v1/users/{user_id}/emails/{email}/verify
Mark email as verified
verifyUserEmail 2 params body → 202404
POST
/v1/users/{user_id}/phone-numbers/{phone_number}/verify
Mark phone as verified
verifyUserPhoneNumber 2 params body → 202404
POST
/v1/users/me/password-credentials
Register password
addPasswordCredentialsToCurrentUser body → 200403
GET
/v1/users/me/device-keys
Get current user's device keys
getDeviceKeysForTenant → 200404

Schemas 33

The contract defines 33 schemas that model the data the API accepts and returns. The most detailed are ApiUser (25 properties), ApiCreateUserInput (16 properties), ApiUpdateUserInput (15 properties), ApiAddress (7 properties). Each schema is shown below with its type and property counts.

PageInfo
object
2 properties 2 required
DeviceKeyResponseDto
object
7 properties 3 required
ApiUserName
object
4 properties
ApiUserEmail
object
3 properties 1 required
ApiCreateOrUpdateAddressInput
object
6 properties
ApiUserPasswordInput
object
2 properties 1 required
DelegatedAccessInput
object
2 properties 2 required
ApiUser
object
25 properties 4 required
ApiUserPhone
object
3 properties 1 required
NotFoundHttpError
object
2 properties 2 required
ApiAddPassword
object
4 properties 1 required
ApiGetAllUsers
object
3 properties 3 required
ApiUsersCount
object
1 property 1 required
ForbiddenHttpError
object
2 properties 2 required
ApiAddress
object
7 properties
AddressType
string
ApiCreateUserInput
object
16 properties
RegisterPasswordResponse
object
1 property 1 required
ApiUserIdentity
object
7 properties 6 required
ApiUserIdentityAlias
object
2 properties 2 required
DeviceStatus
string
ApiPasswordInformation
object
4 properties 3 required
ApiGroup
object
6 properties 4 required
UserVerifyEmailOrPhoneNumberInput
object
1 property
BadRequestHttpError
object
2 properties 2 required
Status
string
IdentifierIsTakenHttpError
object
3 properties 3 required
ApiUpdateUserInput
object
15 properties
ApiMeAddPassword
object
2 properties 1 required
DevicePushConfigDto
object
3 properties 2 required
ApiUserIdentityProvider
object
5 properties 5 required
ApiUpdatePassword
object
2 properties
ApiUserNameInput
object
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

transmit-security-users-api-openapi.yml Raw ↑

Other APIs Transmit Security publishes across the network.

Mosaic Orchestration API
Transmit Security Applications API
Transmit Security Auth API
Transmit Security Manage API
Transmit Security Organizations API
Transmit Security Recommendation API
Transmit Security Token API
Transmit Security Verification API
Where this information came from

This is an independent, third-party profile of Transmit Security Users API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.