The Users API from Fortanix — 20 operation(s) for users.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/fortanix-users-api"curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: Fortanix Users API
license:
name: Apache 2.0
url: http://www.apache.org/licenses/LICENSE-2.0.html
version: '1.0'
description: 'Operations tagged Users across 2 of this provider''s published API definitions: fortanix-ccm-openapi-original.json, fortanix-dsm-openapi-original.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://ccm.fortanix.com
- url: '{dsmEndpoint}'
description: DSM Endpoint
variables:
dsmEndpoint:
default: https://amer.smartkey.io
description: Type your DSM server URL here (include https://)
tags:
- name: Users
paths:
/v1/user:
get:
tags:
- Users
summary: Get details of the current logged in user.
description: Get details of the current logged in user.
operationId: getLoggedInUser
x-auth-resource: UserAuth,Reader,Writer,Manager
responses:
'200':
description: User Details.
content:
application/json:
schema:
$ref: '#/components/schemas/User'
security:
- bearerToken: []
servers:
- url: https://ccm.fortanix.com
/v1/users:
get:
tags:
- Users
summary: Get all user's information.
description: Get user's information with status.
operationId: getAllUsers
x-auth-resource: Reader,Writer,Manager
parameters:
- name: all_search
in: query
description: Search on name or email.
required: false
schema:
type: string
- name: limit
in: query
description: Maximum numbers of users to return.
required: false
schema:
type: integer
- name: offset
in: query
description: Number of users to skip from start.
required: false
schema:
type: integer
- name: sort_by
in: query
description: Sort fields. In the format of key1:ASC,key2:DESC,key3:DESC
required: false
schema:
type: string
responses:
'200':
description: Search result for user's objects.
content:
application/json:
schema:
$ref: '#/components/schemas/GetAllUsersResponse'
security:
- bearerToken: []
post:
tags:
- Users
summary: Create a new user.
description: Sign up a new user.
operationId: createUser
x-auth-resource: NoAuth
parameters:
- $ref: '#/components/parameters/SignupRequest'
responses:
'201':
description: Created user details.
content:
application/json:
schema:
$ref: '#/components/schemas/User'
servers:
- url: https://ccm.fortanix.com
/v1/users/invite:
post:
tags:
- Users
summary: Invite a user.
description: Invite an existing user or a new user to join an existing account.
operationId: inviteUser
x-auth-resource: Manager,ManagerInLockedAccount
parameters:
- $ref: '#/components/parameters/InviteUserRequest'
responses:
'201':
description: Invited User details.
content:
application/json:
schema:
$ref: '#/components/schemas/User'
security:
- bearerToken: []
servers:
- url: https://ccm.fortanix.com
/v1/users/{user-id}:
get:
tags:
- Users
summary: Get details of a particular user.
description: Get details of a user.
operationId: getUser
x-auth-resource: UserAuth,Reader,Writer,Manager
parameters:
- $ref: '#/components/parameters/UserId'
responses:
'200':
description: User Details.
content:
application/json:
schema:
$ref: '#/components/schemas/User'
security:
- bearerToken: []
patch:
tags:
- Users
summary: Update status, name, and the role of a user. User with MANAGER access role can only update another user.
description: Update status, name, and the role of a user. User with MANAGER access role can only update another users.
operationId: UpdateUser
x-auth-resource: UserAuth,Reader,Writer,Manager,ManagerInLockedAccount,WriterInLockedAccount
parameters:
- $ref: '#/components/parameters/UserId'
- $ref: '#/components/parameters/UpdateUserRequest'
responses:
'200':
description: Updated User status, name, and role.
content:
application/json:
schema:
$ref: '#/components/schemas/User'
security:
- bearerToken: []
delete:
tags:
- Users
summary: Completely delete a user profile from system
description: Completely deletes the currently logged in user from the system.
operationId: deleteUserAccount
x-auth-resource: UserAuth,Reader,Writer,Manager,ManagerInLockedAccount,WriterInLockedAccount
parameters:
- $ref: '#/components/parameters/UserId'
responses:
'204':
description: Nothing is returned on success.
security:
- bearerToken: []
servers:
- url: https://ccm.fortanix.com
/v1/users/{user-id}/accounts:
get:
tags:
- Users
summary: Get user accounts
description: Get information about the accounts of which the user is a member
operationId: getUserAccounts
x-auth-resource: UserAuth
parameters:
- $ref: '#/components/parameters/UserId'
responses:
'200':
description: Information about the accounts of the user
content:
application/json:
schema:
$ref: '#/components/schemas/GetUserAccountsResponse'
security:
- bearerToken: []
delete:
tags:
- Users
summary: Remove user's association with an account.
operationId: deleteUserFromAccount
x-auth-resource: Reader,Writer,Manager,ManagerInLockedAccount,WriterInLockedAccount
parameters:
- $ref: '#/components/parameters/UserId'
responses:
'204':
description: Nothing is returned on success.
security:
- bearerToken: []
servers:
- url: https://ccm.fortanix.com
/sys/v1/users/change_password:
post:
operationId: ChangePassword
tags:
- Users
security:
- bearerToken: []
- apiKeyAuth: []
summary: Change user's password.
description: Change user's password.
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/PasswordChangeRequest'
responses:
'204':
description: Nothing is returned on success
servers:
- url: '{dsmEndpoint}'
description: DSM Endpoint
variables:
dsmEndpoint:
default: https://amer.smartkey.io
description: Type your DSM server URL here (include https://)
/sys/v1/users/{user_id}/confirm_email:
post:
operationId: ConfirmEmail
tags:
- Users
security:
- bearerToken: []
- apiKeyAuth: []
summary: Confirms user's email address.
description: Confirms user's email address.
parameters:
- name: user_id
in: path
required: true
schema:
type: string
format: uuid
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ConfirmEmailRequest'
responses:
2XX:
description: Success result
content:
application/json:
schema:
$ref: '#/components/schemas/ConfirmEmailResponse'
servers:
- url: '{dsmEndpoint}'
description: DSM Endpoint
variables:
dsmEndpoint:
default: https://amer.smartkey.io
description: Type your DSM server URL here (include https://)
/sys/v1/users/{user_id}:
delete:
operationId: DeleteStale
tags:
- Users
security:
- bearerToken: []
- apiKeyAuth: []
summary: Delete a stale user (for sysadmins).
description: Delete a stale user (for sysadmins).
parameters:
- name: user_id
in: path
required: true
schema:
type: string
format: uuid
responses:
'204':
description: Nothing is returned on success
get:
operationId: GetUser
tags:
- Users
security:
- bearerToken: []
- apiKeyAuth: []
summary: Lookup a user.
description: Lookup a user.
parameters:
- name: user_id
in: path
required: true
schema:
type: string
format: uuid
- $ref: '#/components/parameters/GetUserParams'
responses:
2XX:
description: Success result
content:
application/json:
schema:
$ref: '#/components/schemas/User_2'
patch:
operationId: UpdateUser
tags:
- Users
security:
- bearerToken: []
- apiKeyAuth: []
summary: 'Change a user''s properties like first_name, last_name,
description, etc.'
description: 'Change a user''s properties like first_name, last_name,
description, etc.'
parameters:
- name: user_id
in: path
required: true
schema:
type: string
format: uuid
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UserRequest'
responses:
2XX:
description: Success result
content:
application/json:
schema:
$ref: '#/components/schemas/User_2'
servers:
- url: '{dsmEndpoint}'
description: DSM Endpoint
variables:
dsmEndpoint:
default: https://amer.smartkey.io
description: Type your DSM server URL here (include https://)
/sys/v1/users:
delete:
operationId: DeleteUser
tags:
- Users
security:
- bearerToken: []
- apiKeyAuth: []
summary: Delete the currently logged-in user.
description: Delete the currently logged-in user.
responses:
'204':
description: Nothing is returned on success
get:
operationId: ListUsers
tags:
- Users
security:
- bearerToken: []
- apiKeyAuth: []
summary: Get all users accessible to the requester.
description: Get all users accessible to the requester.
parameters:
- $ref: '#/components/parameters/ListUsersParams'
responses:
2XX:
description: Success result
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/User_2'
post:
operationId: SignupUser
tags:
- Users
security:
- bearerToken: []
- apiKeyAuth: []
summary: Create a new user with the given properties.
description: Create a new user with the given properties.
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/SignupRequest_2'
responses:
2XX:
description: Success result
content:
application/json:
schema:
$ref: '#/components/schemas/User_2'
servers:
- url: '{dsmEndpoint}'
description: DSM Endpoint
variables:
dsmEndpoint:
default: https://amer.smartkey.io
description: Type your DSM server URL here (include https://)
/sys/v1/users/{user_id}/accounts:
delete:
operationId: DeleteUserAccount
tags:
- Users
security:
- bearerToken: []
- apiKeyAuth: []
summary: Remove user's association with an account.
description: Remove user's association with an account.
parameters:
- name: user_id
in: path
required: true
schema:
type: string
format: uuid
responses:
'204':
description: Nothing is returned on success
servers:
- url: '{dsmEndpoint}'
description: DSM Endpoint
variables:
dsmEndpoint:
default: https://amer.smartkey.io
description: Type your DSM server URL here (include https://)
/sys/v1/users/forgot_password:
post:
operationId: ForgotPassword
tags:
- Users
security:
- bearerToken: []
- apiKeyAuth: []
summary: Initiate password reset sequence for a user.
description: Initiate password reset sequence for a user.
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ForgotPasswordRequest'
responses:
'204':
description: Nothing is returned on success
servers:
- url: '{dsmEndpoint}'
description: DSM Endpoint
variables:
dsmEndpoint:
default: https://amer.smartkey.io
description: Type your DSM server URL here (include https://)
/sys/v1/users/generate_recovery_codes:
post:
operationId: GenerateRecoveryCodes
tags:
- Users
security:
- bearerToken: []
- apiKeyAuth: []
summary: Generate recovery codes for two factor authentication.
description: 'Generate backup recovery codes that may be used to complete two
factor authentication. Two factor configuration must be unlocked
to use this API.'
responses:
2XX:
description: Success result
content:
application/json:
schema:
$ref: '#/components/schemas/RecoveryCodes'
servers:
- url: '{dsmEndpoint}'
description: DSM Endpoint
variables:
dsmEndpoint:
default: https://amer.smartkey.io
description: Type your DSM server URL here (include https://)
/sys/v1/users/accounts:
get:
operationId: GetUserAccounts
tags:
- Users
security:
- bearerToken: []
- apiKeyAuth: []
summary: Get user's accounts.
description: Get user's accounts.
responses:
2XX:
description: Success result
content:
application/json:
schema:
type: object
additionalProperties:
$ref: '#/components/schemas/UserAccountFlags'
servers:
- url: '{dsmEndpoint}'
description: DSM Endpoint
variables:
dsmEndpoint:
default: https://amer.smartkey.io
description: Type your DSM server URL here (include https://)
/sys/v1/users/permissions:
get:
operationId: GetUserPermissions
tags:
- Users
security:
- bearerToken: []
- apiKeyAuth: []
summary: Returns the caller's permissions
description: Returns the caller's permissions
parameters:
- $ref: '#/components/parameters/GetUserPermissionsParams'
responses:
2XX:
description: Success result
content:
application/json:
schema:
$ref: '#/components/schemas/GetUserPermissionsResponse'
servers:
- url: '{dsmEndpoint}'
description: DSM Endpoint
variables:
dsmEndpoint:
default: https://amer.smartkey.io
description: Type your DSM server URL here (include https://)
/sys/v1/users/invite:
post:
operationId: InviteUser
tags:
- Users
security:
- bearerToken: []
- apiKeyAuth: []
summary: Invite an existing user or new user to join an existing account.
description: Invite an existing user or new user to join an existing account.
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UserRequest'
responses:
2XX:
description: Success result
content:
application/json:
schema:
$ref: '#/components/schemas/User_2'
servers:
- url: '{dsmEndpoint}'
description: DSM Endpoint
variables:
dsmEndpoint:
default: https://amer.smartkey.io
description: Type your DSM server URL here (include https://)
/sys/v1/users/process_invite:
post:
operationId: ProcessInvite
tags:
- Users
security:
- bearerToken: []
- apiKeyAuth: []
summary: Accept or reject pending account invitations.
description: Accept or reject pending account invitations.
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ProcessInviteRequest'
responses:
'204':
description: Nothing is returned on success
servers:
- url: '{dsmEndpoint}'
description: DSM Endpoint
variables:
dsmEndpoint:
default: https://amer.smartkey.io
description: Type your DSM server URL here (include https://)
/sys/v1/users/resend_confirm_email:
post:
operationId: ResendConfirmEmail
tags:
- Users
security:
- bearerToken: []
- apiKeyAuth: []
summary: Resend email with link to confirm user's email address.
description: Resend email with link to confirm user's email address.
responses:
'204':
description: Nothing is returned on success
servers:
- url: '{dsmEndpoint}'
description: DSM Endpoint
variables:
dsmEndpoint:
default: https://amer.smartkey.io
description: Type your DSM server URL here (include https://)
/sys/v1/users/{user_id}/resend_invite:
post:
operationId: ResendInvite
tags:
- Users
security:
- bearerToken: []
- apiKeyAuth: []
summary: Resend invite to the user to join a specific account.
description: Resend invite to the user to join a specific account.
parameters:
- name: user_id
in: path
required: true
schema:
type: string
format: uuid
responses:
'204':
description: Nothing is returned on success
servers:
- url: '{dsmEndpoint}'
description: DSM Endpoint
variables:
dsmEndpoint:
default: https://amer.smartkey.io
description: Type your DSM server URL here (include https://)
/sys/v1/users/{user_id}/reset_password:
post:
operationId: ResetPassword
tags:
- Users
security:
- bearerToken: []
- apiKeyAuth: []
summary: Reset a user's password. Requires a valid password reset token.
description: Reset a user's password. Requires a valid password reset token.
parameters:
- name: user_id
in: path
required: true
schema:
type: string
format: uuid
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/PasswordResetRequest'
responses:
'204':
description: Nothing is returned on success
servers:
- url: '{dsmEndpoint}'
description: DSM Endpoint
variables:
dsmEndpoint:
default: https://amer.smartkey.io
description: Type your DSM server URL here (include https://)
/sys/v1/users/{user_id}/validate_token:
post:
operationId: ValidateToken
tags:
- Users
security:
- bearerToken: []
- apiKeyAuth: []
summary: Validates password reset token for the user.
description: Validates password reset token for the user.
parameters:
- name: user_id
in: path
required: true
schema:
type: string
format: uuid
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ValidateTokenRequest'
responses:
2XX:
description: Success result
content:
application/json:
schema:
$ref: '#/components/schemas/ValidateTokenResponse'
servers:
- url: '{dsmEndpoint}'
description: DSM Endpoint
variables:
dsmEndpoint:
default: https://amer.smartkey.io
description: Type your DSM server URL here (include https://)
components:
schemas:
User:
type: object
required:
- user_id
- user_email
properties:
user_id:
type: string
format: uuid
description: User Id.
first_name:
type: string
description: First Name.
last_name:
type: string
description: Last Name.
user_email:
type: string
description: User Email.
last_logged_in_at:
type: integer
format: int64
description: Last login time of user.
created_at:
type: integer
format: int64
description: Creation time of user.
email_verified:
type: boolean
description: Whether this user's email has been verified.
status:
$ref: '#/components/schemas/UserStatus'
roles:
type: array
items:
$ref: '#/components/schemas/AccessRoles'
user_account_status:
$ref: '#/components/schemas/UserAccountStatus'
accepted_latest_terms_and_conditions:
type: boolean
description: Whether this user has accepted latest terms and conditions or not.
new_email:
type: string
description: User’s new email address before it has been confirmed.
UserAccountStatus:
type: string
description: Status of an Account for a user.
enum:
- ACTIVE
- PENDING
- DISABLED
SignupRequest:
type: object
required:
- user_email
- user_password
properties:
user_email:
type: string
description: User's email address.
user_password:
type: string
format: password
description: The password to assign to this user in Confidential Computing Manager.
first_name:
type: string
last_name:
type: string
recaptcha_response:
type: string
AccessRoles:
type: string
description: Roles of a user.
enum:
- READER
- WRITER
- MANAGER
InviteUserRequest:
type: object
required:
- user_email
- roles
properties:
user_email:
type: string
description: User's email address.
roles:
type: array
items:
$ref: '#/components/schemas/AccessRoles'
first_name:
type: string
last_name:
type: string
UpdateUserRequest:
type: object
properties:
first_name:
type: string
description: First name.
last_name:
type: string
description: Last name.
roles:
type: array
items:
$ref: '#/components/schemas/AccessRoles'
user_account_status:
$ref: '#/components/schemas/UserAccountStatus'
user_email:
type: string
description: User's new email address.
UserAccountInfo:
type: object
required:
- roles
- status
properties:
roles:
type: array
description: Role of the current user in the account.
items:
$ref: '#/components/schemas/AccessRoles'
status:
$ref: '#/components/schemas/UserAccountStatus'
UserStatus:
type: string
description: Status of a user.
enum:
- ACTIVE
- PENDING
- DISABLED
SearchMetadata:
type: object
required:
- total_count
- filtered_count
- page
- pages
- limit
properties:
page:
type: integer
description: Current page number
pages:
type: integer
description: Total pages as per the item counts and page limit.
limit:
type: integer
description: Number of items to limit in a page.
total_count:
type: integer
description: Total number of unfiltered items.
filtered_count:
type: integer
description: Total number of items as per the current filter.
GetAllUsersResponse:
type: object
required:
- items
properties:
metadata:
$ref: '#/components/schemas/SearchMetadata'
items:
type: array
items:
$ref: '#/components/schemas/User'
GetUserAccountsResponse:
type: object
description: Application configurations attached to the image.
additionalProperties:
$ref: '#/components/schemas/UserAccountInfo'
GetUserPermissionsResponse:
allOf:
- type: object
properties:
account:
type: array
items:
$ref: '#/components/schemas/AccountPermissions'
description: User's permissions in the account.
all_groups:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/GroupPermissions'
description: 'User''s permissions in all groups. Note that this will only be returned
if the user has one or more all-groups roles.'
groups:
type: object
additionalProperties:
type: array
items:
$ref: '#/components/schemas/GroupPermissions'
description: User's permissions in groups.
required:
- account
- groups
MfaRenameDeviceRequest:
allOf:
- type: object
description: Request to rename a FIDO device.
properties:
old_name:
type: string
maxLength: 4096
pattern: ^[^\n]*[^\s\n][^\n]*$
description: Old name of FIDO device.
new_name:
type: string
maxLength: 4096
pattern: ^[^\n]*[^\s\n][^\n]*$
description: New name of FIDO device.
required:
- old_name
- new_name
UserSort:
oneOf:
- title: UserSortVariantByUserId
type: object
properties:
sort:
type: string
pattern: ^user_id:(?:asc|desc)$
example: user_id:asc
start:
type: string
format: uuid
required:
- sort
GetUserPermissionsParams:
allOf:
- type: object
properties:
with_implied:
type: boolean
description: 'If `true`, implied permissions are added in the output. For example, if
permission A implies permission B, and the user has permission A, the
output will include both A and B if this is set to `true`. If this is
set to `false`, B will only be returned if it was assigned to the user
directly.'
UserGroupRole:
description: User's role(s) in a group.
allOf:
- type: array
uniqueItems: true
items:
$ref: '#/components/schemas/LegacyUserGroupRoleOrRoleId'
PasswordResetRequest:
allOf:
- type: object
description: Request to perform a password reset.
properties:
reset_token:
type: string
new_password:
type: string
required:
- reset_token
- new_password
WithGroups:
type: string
enum:
- all
- explicit_only
- none
ForgotPasswordRequest:
allOf:
- type: object
description: Initiate password reset sequence.
properties:
user_email:
type: string
format: email
recaptcha_response:
type:
- string
- 'null'
required:
- user_email
Base64UrlSafe:
type: string
format: byte
User_2:
allOf:
- type: object
properties:
account_role:
$ref: '#/components/schemas/UserAccountFlags'
created_at:
type: string
pattern: ^\d{4}\d{2}\d{2}T\d{2}\d{2}\d{2}Z$
example: 20170509T070912Z
dependent_services:
type:
- array
- 'null'
uniqueItems: true
items:
type: string
maxLength: 4096
pattern: ^[^\n]*[^\s\n][^\n]*$
description:
type:
- string
- 'null'
email_verified:
type:
- boolean
- 'null'
explicit_groups:
type:
- object
- 'null'
additionalProperties:
$ref: '#/components/schemas/UserGroupRole'
description: 'Explicit group assignments.
This is similar to `groups` field except that it does not include groups due to
all-groups roles. Use this field to find out which group assignments can be
changed using `mod_groups` and `del_groups` fields in user update API.'
first_name:
type:
- string
- 'null'
maxLength: 4096
pattern: ^[^\n]*[^\s\n][^\n]*$
groups:
type:
- object
- 'null'
additionalProperties:
$ref: '#/components/schemas/UserGroupRole'
has_account:
type:
- boolean
- 'null'
has_password:
type:
- boolean
- 'null'
last_logged_in_at:
type: string
pattern: ^\d{4}\d{2}\d{2}T\d{2}\d{2}\d{2}Z$
example: 20170509T070912Z
last_name:
type:
- string
- 'null'
maxLength: 4096
pattern: ^[^\n]*[^\s\n][^\n]*$
mfa_devices:
type: array
items:
$ref: '#/components/schemas/MfaDevice'
description: Mfa devices registered with the user
new_email:
type: string
format: email
self_provisioned:
type:
- boolean
- 'null'
u2f_devices:
type: array
items:
$ref: '#/components/schemas/MfaDevice'
user_email:
type: string
format: email
user_id:
type: string
format: uuid
required:
- account_role
- mfa_devices
- u2f_devices
- user_email
- user_id
UserAccountFlags:
description: User's role(s) and state in an account.
allOf:
- type: array
uniqueItems: true
items:
$ref: '#/components/schemas/UserAccountFlagOrRole'
PublicKeyCredentialAuthenticatorAttestationResponse:
allOf:
- type: object
description: 'Contains the attributes that are returned to the caller when a new
credential is created, or a new assertion is requested.'
properties:
id:
$ref: '#/components/schemas/Base64UrlSafe'
description: Credential's identifier.
type:
$ref: '#/components/schemas/PublicKeyCredentialType'
description: Type of credential.
response:
$ref: '#/components/schemas/AuthenticatorAttestationResponse'
get_client_extension_results:
$ref: '#/components/schemas/AuthenticationExtensionsClientOutputs'
description: 'This field contains client extension output entries produced
by the extension’s client extension processing.'
ListUsersParams:
allOf:
- type: object
properties:
group_id:
type:
# --- truncated at 32 KB (70 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/fortanix/refs/heads/main/openapi/fortanix-users-api-openapi.yml