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
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Fortanix

Fortanix Users API

The Users API from Fortanix — 20 operation(s) for users.

Documentation Provider Profile APIs.io OpenAPI GitHub

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

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

This API exposes 28 operations across 20 paths, and defines 51 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

Requests are made against 2 base URLs: https://ccm.fortanix.com, {dsmEndpoint}.

28 operations 20 paths 51 schemas 5 DELETE8 GET2 PATCH13 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
Base URL
https://amer.smartkey.io
Authentication
API Key, HTTP Basic, API Key
License
Apache 2.0
Resource Areas
1

Authentication & Security 3

Fortanix Users API declares 3 security schemes for authenticating requests. An API key is passed in the header as Authentication (bearerToken). It accepts HTTP basic authentication (basicAuth). An API key is passed in the header as Authorization (apiKeyAuth).

  • bearerToken — A JWT bearer token to be passed once authenticated.
  • apiKeyAuth — Please enter your token prefixed with 'Basic ' (e.g., 'Basic yourtokenhere')

Paths & Operations 28

Across 20 paths, the API surfaces 28 operations — 5 DELETE, 8 GET, 2 PATCH, 13 POST. Each is listed below with its method, path, parameters, and response codes.

Users 28
GET
/v1/user
Get details of the current logged in user.
getLoggedInUser → 200
GET
/v1/users
Get all user's information.
getAllUsers 4 params → 200
POST
/v1/users
Create a new user.
createUser 1 param → 201
POST
/v1/users/invite
Invite a user.
inviteUser 1 param → 201
GET
/v1/users/{user-id}
Get details of a particular user.
getUser 1 param → 200
PATCH
/v1/users/{user-id}
Update status, name, and the role of a user. User with MANAGER access role can only update another user.
UpdateUser 2 params → 200
DELETE
/v1/users/{user-id}
Completely delete a user profile from system
deleteUserAccount 1 param → 204
GET
/v1/users/{user-id}/accounts
Get user accounts
getUserAccounts 1 param → 200
DELETE
/v1/users/{user-id}/accounts
Remove user's association with an account.
deleteUserFromAccount 1 param → 204
POST
/sys/v1/users/change_password
Change user's password.
ChangePassword body → 204
POST
/sys/v1/users/{user_id}/confirm_email
Confirms user's email address.
ConfirmEmail 1 param body → 2XX
DELETE
/sys/v1/users/{user_id}
Delete a stale user (for sysadmins).
DeleteStale 1 param → 204
GET
/sys/v1/users/{user_id}
Lookup a user.
GetUser 2 params → 2XX
PATCH
/sys/v1/users/{user_id}
Change a user's properties like firstname, lastname, description, etc.
UpdateUser 1 param body → 2XX
DELETE
/sys/v1/users
Delete the currently logged-in user.
DeleteUser → 204
GET
/sys/v1/users
Get all users accessible to the requester.
ListUsers 1 param → 2XX
POST
/sys/v1/users
Create a new user with the given properties.
SignupUser body → 2XX
DELETE
/sys/v1/users/{user_id}/accounts
Remove user's association with an account.
DeleteUserAccount 1 param → 204
POST
/sys/v1/users/forgot_password
Initiate password reset sequence for a user.
ForgotPassword body → 204
POST
/sys/v1/users/generate_recovery_codes
Generate recovery codes for two factor authentication.
GenerateRecoveryCodes → 2XX
GET
/sys/v1/users/accounts
Get user's accounts.
GetUserAccounts → 2XX
GET
/sys/v1/users/permissions
Returns the caller's permissions
GetUserPermissions 1 param → 2XX
POST
/sys/v1/users/invite
Invite an existing user or new user to join an existing account.
InviteUser body → 2XX
POST
/sys/v1/users/process_invite
Accept or reject pending account invitations.
ProcessInvite body → 204
POST
/sys/v1/users/resend_confirm_email
Resend email with link to confirm user's email address.
ResendConfirmEmail → 204
POST
/sys/v1/users/{user_id}/resend_invite
Resend invite to the user to join a specific account.
ResendInvite 1 param → 204
POST
/sys/v1/users/{user_id}/reset_password
Reset a user's password. Requires a valid password reset token.
ResetPassword 1 param body → 204
POST
/sys/v1/users/{user_id}/validate_token
Validates password reset token for the user.
ValidateToken 1 param body → 2XX

Schemas 51

The contract defines 51 schemas that model the data the API accepts and returns. The most detailed are User (12 properties), SearchMetadata (5 properties), UpdateUserRequest (5 properties), SignupRequest (5 properties). Each schema is shown below with its type and property counts.

User
object
12 properties 2 required
UserAccountStatus
string
Status of an Account for a user.
SignupRequest
object
5 properties 2 required
AccessRoles
string
Roles of a user.
InviteUserRequest
object
4 properties 2 required
UpdateUserRequest
object
5 properties
UserAccountInfo
object
2 properties 2 required
UserStatus
string
Status of a user.
SearchMetadata
object
5 properties 5 required
GetAllUsersResponse
object
2 properties 1 required
GetUserAccountsResponse
object
Application configurations attached to the image.
GetUserPermissionsResponse
MfaRenameDeviceRequest
UserSort
GetUserPermissionsParams
UserGroupRole
User's role(s) in a group.
PasswordResetRequest
WithGroups
string
ForgotPasswordRequest
Base64UrlSafe
string
User_2
UserAccountFlags
User's role(s) and state in an account.
PublicKeyCredentialAuthenticatorAttestationResponse
ListUsersParams
AuthenticatorAttestationResponse
AuthenticatorTransportInner
string
See [AuthenticatorTransport] type.
PublicKeyCredentialType
string
https://www.w3.org/TR/webauthn-2/enum-credentialType This enum defines valid cred types.
ValidateTokenRequest
UserRequest
SignupRequest_2
LegacyUserGroupRole
string
Legacy user group role
AuthenticationExtensionsClientOutputs
UserAccountFlagOrRole
User account flag or legacy user account role name or custom role id
LegacyUserGroupRoleOrRoleId
Legacy user group role name or custom role id
MfaDevice
ConfirmEmailResponse
U2fAddDeviceRequest
AuthenticatorTransport
Hints by relying party on how client should communicate with the authenticator. https://www.w3.org/TR/webauthn-2/enum-transport
GroupPermissions
string
CREATEGROUPAPPROVALPOLICY: Permission to create group-level approval policy. Note that updating/deleting the approval policy is protected by the approval polic…
AccountPermissions
string
MANAGELOGGING: Permission to manage logging integrations, and enable/disable error logging. MANAGEAUTH: Permission to manage SSO and password policy. MANAGEWOR…
ValidateTokenResponse
GetUserParams
ConfirmEmailRequest
ProcessInviteRequest
FidoAddDeviceRequest
PasswordChangeRequest
MfaDelDeviceRequest
RecoveryCodes
LegacyUserAccountRole
string
Legacy user account role
MfaDeviceType
string
Type of MFA device
UserAccountFlag
string
User account flag

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

fortanix-users-api-openapi.yml Raw ↑

Other APIs Fortanix publishes across the network.

Fortanix Confidential Computing Manager REST API
AE Profile APIs.io
Fortanix Account Extensions API
AE Profile APIs.io
Fortanix Accounts API
AE Profile APIs.io
Fortanix Admin API
AE Profile APIs.io
Fortanix App API
AE Profile APIs.io
Fortanix Application Config API
AE Profile APIs.io
Fortanix Approval Requests API
AE Profile APIs.io
Fortanix Approval Requests API
AE Profile APIs.io
Fortanix Apps API
AE Profile APIs.io
Fortanix Auth API
AE Profile APIs.io
Fortanix Authentication API
AE Profile APIs.io
Fortanix Batch API
AE Profile APIs.io
#User
← Back to F APIs
API Details
ID
fortanix:fortanix-users-api
Base URL
https://amer.smartkey.io
Docs
https://support.fortanix.com/apidocs/dsm-introduction
Provider
Fortanix
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=fortanix-users-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/fortanix-users-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of Fortanix 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.