# SecureAuth (incl. Cloudentity) Users API

**Canonical:** https://apis.io/apis/secureauth/secureauth-users-api/  
**Provider:** SecureAuth (incl. Cloudentity) — https://apis.io/providers/secureauth/  
**Base URL:** https://localhost:8443/api/identity/default  
**Documentation:** https://docs.secureauth.com/iam/docs/api

SecureAuth (incl. Cloudentity) Users API is one of 85 APIs that [SecureAuth (incl. Cloudentity)](https://apis.io/providers/secureauth/) 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 and API documentation.

The Users API from SecureAuth (incl. Cloudentity) — 68 operation(s) for users.

## Operations (60 of 79)

| Method | Path | Summary |
|---|---|---|
| GET | `/admin/pools/{ipID}/users` | List Users |
| POST | `/admin/pools/{ipID}/users` | Create User Account |
| DELETE | `/admin/pools/{ipID}/users/{userID}` | Delete User Account |
| GET | `/admin/pools/{ipID}/users/{userID}` | Get User Details |
| PATCH | `/admin/pools/{ipID}/users/{userID}` | Patches existing User (supports both RFC6902 and RFC7396 JSON Patch) |
| PUT | `/admin/pools/{ipID}/users/{userID}` | Update User Record |
| POST | `/admin/pools/{ipID}/users/{userID}/activation/send` | Send Activation Message |
| POST | `/admin/pools/{ipID}/users/{userID}/addresses/add` | Add Verifiable Address |
| POST | `/admin/pools/{ipID}/users/{userID}/addresses/remove` | Delete Verifiable Address |
| POST | `/admin/pools/{ipID}/users/{userID}/addresses/update` | Update Verifiable Address |
| POST | `/admin/pools/{ipID}/users/{userID}/identifiers/add` | Add Identifier |
| POST | `/admin/pools/{ipID}/users/{userID}/identifiers/remove` | Remove Identifier |
| GET | `/admin/pools/{ipID}/users/{userID}/metadata/{metadataType}` | Get User Metadata |
| PUT | `/admin/pools/{ipID}/users/{userID}/metadata/{metadataType}` | Set User Metadata |
| POST | `/admin/pools/{ipID}/users/{userID}/password/reset/request` | Request Password Reset |
| PUT | `/admin/pools/{ipID}/users/{userID}/password/state` | Set Password State |
| POST | `/public/pools/{ipID}/reset-password/confirm` | Confirm Reset Password |
| POST | `/self/change-password` | Change Password |
| GET | `/self/me` | Self Get User Profile |
| PUT | `/self/me` | Self Update User Profile |
| POST | `/v2/self/change-password` | Change Password |
| POST | `/v2/self/change-totp-secret` | Change Totp Secret |
| GET | `/v2/self/me` | Self Get User Profile |
| PUT | `/v2/self/me` | Self Update User Profile |
| POST | `/v2/self/set-password` | Set Password |
| POST | `/v2/self/set-totp-secret` | Set Totp Secret |
| POST | `/v2/self/set-webauthn` | Set WebAuthn |
| POST | `/v2/self/usernameless-webauthn/create/begin` | Begin usernameless WebAuthn credentials generation |
| POST | `/v2/self/usernameless-webauthn/create/complete` | Finish usernameless WebAuthn credentials generation |
| DELETE | `/v2/self/webauthn/{webAuthnCredentialID}` | Delete WebAuthn key |
| PUT | `/v2/self/webauthn/{webAuthnCredentialID}/name` | Name WebAuthn key |
| POST | `/v2/self/webauthn/create/begin` | Begin WebAuthn credentials generation |
| POST | `/v2/self/webauthn/create/complete` | Finish WebAuthn credentials generation |
| POST | `/system/pools/{ipID}/user/activate` | Activate User Using Extended Code |
| POST | `/system/pools/{ipID}/user/authentication-code/verify` | Verify User's Authentication Code |
| POST | `/system/pools/{ipID}/user/code/generate` | Generate code of a specific type |
| POST | `/system/pools/{ipID}/user/password/reset/complete` | Complete Reset Password |
| POST | `/system/pools/{ipID}/user/password/reset/confirm` | Confirm Reset Password |
| POST | `/system/pools/{ipID}/user/password/reset/request` | Request Reset Password |
| POST | `/system/pools/{ipID}/user/password/v2/verify` | Verify User's Password |
| POST | `/system/pools/{ipID}/user/password/verify` | Verify User's Password |
| POST | `/system/pools/{ipID}/user/register` | Self Register User |
| POST | `/system/pools/{ipID}/user/totp/reset/complete` | Complete Reset Totp Secret |
| POST | `/system/pools/{ipID}/user/totp/reset/request` | Request Reset Totp Secret |
| POST | `/system/pools/{ipID}/user/usernameless-webauthn/login/begin` | Begin Usernameless WebAuthn Login Verification |
| POST | `/system/pools/{ipID}/user/usernameless-webauthn/login/complete` | Complete Usernameless WebAuthn Login Verification |
| POST | `/system/pools/{ipID}/user/webauthn/add/complete` | Complete Add WebAuthn |
| POST | `/system/pools/{ipID}/user/webauthn/add/request` | Request Add WebAuthn |
| POST | `/system/pools/{ipID}/user/webauthn/login/begin` | Begin WebAuthn Login Verification |
| POST | `/system/pools/{ipID}/user/webauthn/login/complete` | Complete WebAuthn Login Verification |
| GET | `/system/pools/{ipID}/users` | List Users |
| POST | `/system/pools/{ipID}/users` | Create User |
| DELETE | `/system/pools/{ipID}/users/{userID}` | Delete User Account |
| GET | `/system/pools/{ipID}/users/{userID}` | Get User Details |
| PATCH | `/system/pools/{ipID}/users/{userID}` | Patches existing User (supports both RFC6902 and RFC7396 JSON Patch) |
| PUT | `/system/pools/{ipID}/users/{userID}` | Update User Record |
| POST | `/system/pools/{ipID}/users/{userID}/activate` | Activate User With Code |
| POST | `/system/pools/{ipID}/users/{userID}/activation/generate` | Generate Activation Code |
| POST | `/system/pools/{ipID}/users/{userID}/activation/send` | Send Activation Message |
| POST | `/system/pools/{ipID}/users/{userID}/addresses/add` | Add Verifiable Address |

…and 19 more operations. They are listed in full on the page.

## Machine-readable artifacts (2)

- **OpenAPI** — https://artifacts.apis.io/secureauth/openapi/secureauth-users-api-openapi.yml
- **Documentation** — https://docs.secureauth.com/iam/docs/api

## Other SecureAuth (incl. Cloudentity) APIs (12)

- [SecureAuth (incl. Cloudentity) ACRs API](https://apis.io/apis/secureauth/secureauth-acrs-api/)
- [SecureAuth (incl. Cloudentity) APIs API](https://apis.io/apis/secureauth/secureauth-apis-api/)
- [SecureAuth (incl. Cloudentity) Applications API](https://apis.io/apis/secureauth/secureauth-applications-api/)
- [SecureAuth (incl. Cloudentity) Audit Events API](https://apis.io/apis/secureauth/secureauth-audit-events-api/)
- [SecureAuth (incl. Cloudentity) Audit Events API](https://apis.io/apis/secureauth/secureauth-auditevents-api/)
- [SecureAuth (incl. Cloudentity) Authorization Details API](https://apis.io/apis/secureauth/secureauth-authorizationdetails-api/)
- [SecureAuth (incl. Cloudentity) B2B Users API](https://apis.io/apis/secureauth/secureauth-b2busers-api/)
- [SecureAuth (incl. Cloudentity) Brute Force Limits API](https://apis.io/apis/secureauth/secureauth-bruteforcelimits-api/)
- [SecureAuth (incl. Cloudentity) Captcha API](https://apis.io/apis/secureauth/secureauth-captcha-api/)
- [SecureAuth (incl. Cloudentity) CDR API](https://apis.io/apis/secureauth/secureauth-cdr-api/)
- [SecureAuth (incl. Cloudentity) Claims API](https://apis.io/apis/secureauth/secureauth-claims-api/)
- [SecureAuth (incl. Cloudentity) Clients API](https://apis.io/apis/secureauth/secureauth-clients-api/)

## Tags

User

---

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