# Fortanix Users API

**Canonical:** https://apis.io/apis/fortanix/fortanix-users-api/  
**Provider:** Fortanix — https://apis.io/providers/fortanix/  
**Base URL:** https://amer.smartkey.io  
**Documentation:** https://support.fortanix.com/apidocs/dsm-introduction

Fortanix Users API is one of 51 APIs that [Fortanix](https://apis.io/providers/fortanix/) publishes on the [APIs.io](https://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.

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

## Operations (28)

| Method | Path | Summary |
|---|---|---|
| GET | `/v1/user` | Get details of the current logged in user. |
| GET | `/v1/users` | Get all user's information. |
| POST | `/v1/users` | Create a new user. |
| POST | `/v1/users/invite` | Invite a user. |
| GET | `/v1/users/{user-id}` | Get details of a particular user. |
| PATCH | `/v1/users/{user-id}` | Update status, name, and the role of a user. User with MANAGER access role can only update another user. |
| DELETE | `/v1/users/{user-id}` | Completely delete a user profile from system |
| GET | `/v1/users/{user-id}/accounts` | Get user accounts |
| DELETE | `/v1/users/{user-id}/accounts` | Remove user's association with an account. |
| POST | `/sys/v1/users/change_password` | Change user's password. |
| POST | `/sys/v1/users/{user_id}/confirm_email` | Confirms user's email address. |
| DELETE | `/sys/v1/users/{user_id}` | Delete a stale user (for sysadmins). |
| GET | `/sys/v1/users/{user_id}` | Lookup a user. |
| PATCH | `/sys/v1/users/{user_id}` | Change a user's properties like first_name, last_name, description, etc. |
| DELETE | `/sys/v1/users` | Delete the currently logged-in user. |
| GET | `/sys/v1/users` | Get all users accessible to the requester. |
| POST | `/sys/v1/users` | Create a new user with the given properties. |
| DELETE | `/sys/v1/users/{user_id}/accounts` | Remove user's association with an account. |
| POST | `/sys/v1/users/forgot_password` | Initiate password reset sequence for a user. |
| POST | `/sys/v1/users/generate_recovery_codes` | Generate recovery codes for two factor authentication. |
| GET | `/sys/v1/users/accounts` | Get user's accounts. |
| GET | `/sys/v1/users/permissions` | Returns the caller's permissions |
| POST | `/sys/v1/users/invite` | Invite an existing user or new user to join an existing account. |
| POST | `/sys/v1/users/process_invite` | Accept or reject pending account invitations. |
| POST | `/sys/v1/users/resend_confirm_email` | Resend email with link to confirm user's email address. |
| POST | `/sys/v1/users/{user_id}/resend_invite` | Resend invite to the user to join a specific account. |
| POST | `/sys/v1/users/{user_id}/reset_password` | Reset a user's password. Requires a valid password reset token. |
| POST | `/sys/v1/users/{user_id}/validate_token` | Validates password reset token for the user. |

## Machine-readable artifacts (5)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/fortanix/refs/heads/main/openapi/fortanix-users-api-openapi.yml
- **Documentation** — https://support.fortanix.com/docs/dsm-rest-apis
- **APIReference** — https://support.fortanix.com/apidocs/dsm-introduction
- **APIReference** — https://support.fortanix.com/apidocs/armor-ki-introduction
- **Documentation** — https://support.fortanix.com/docs/fortanix-armor-rest-apis

## Other Fortanix APIs (12)

- [Fortanix Confidential Computing Manager REST API](https://apis.io/apis/fortanix/ccm/)
- [Fortanix Account Extensions API](https://apis.io/apis/fortanix/fortanix-account-extensions-api/)
- [Fortanix Accounts API](https://apis.io/apis/fortanix/fortanix-accounts-api/)
- [Fortanix Admin API](https://apis.io/apis/fortanix/fortanix-admin-api/)
- [Fortanix App API](https://apis.io/apis/fortanix/fortanix-app-api/)
- [Fortanix Application Config API](https://apis.io/apis/fortanix/fortanix-applicationconfig-api/)
- [Fortanix Approval Requests API](https://apis.io/apis/fortanix/fortanix-approval-requests-api/)
- [Fortanix Approval Requests API](https://apis.io/apis/fortanix/fortanix-approvalrequests-api/)
- [Fortanix Apps API](https://apis.io/apis/fortanix/fortanix-apps-api/)
- [Fortanix Auth API](https://apis.io/apis/fortanix/fortanix-auth-api/)
- [Fortanix Authentication API](https://apis.io/apis/fortanix/fortanix-authentication-api/)
- [Fortanix Batch API](https://apis.io/apis/fortanix/fortanix-batch-api/)

## Tags

User

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/fortanix/fortanix-users-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/fortanix/.
