SecureAuth (incl. Cloudentity)

SecureAuth (incl. Cloudentity) Users API

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

GitHub OpenAPI
Business capability
Identity & Access Management BC-620.20

Operations 79

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 #
POST /system/pools/{ipID}/users/{userID}/addresses/remove Delete Verifiable Address #
POST /system/pools/{ipID}/users/{userID}/addresses/set Set Verifiable Addresses #
POST /system/pools/{ipID}/users/{userID}/addresses/update Update Verifiable Address #
POST /system/pools/{ipID}/users/{userID}/change-password Change Password #
POST /system/pools/{ipID}/users/{userID}/change_password Change Password #
POST /system/pools/{ipID}/users/{userID}/code/generate Generate code of a specific type #
POST /system/pools/{ipID}/users/{userID}/devices/set Set Devices #
POST /system/pools/{ipID}/users/{userID}/identifiers/add Add Identifier #
POST /system/pools/{ipID}/users/{userID}/identifiers/remove Remove Identifier #
POST /system/pools/{ipID}/users/{userID}/identifiers/set Set Identifiers #
PUT /system/pools/{ipID}/users/{userID}/password/state Set Password State #
POST /system/pools/{ipID}/users/{userID}/totp/change Change Totp Secret #
POST /system/pools/{ipID}/users/{userID}/usernameless-webauthn/create/begin Begin usernameless WebAuthn credentials generation #
POST /system/pools/{ipID}/users/{userID}/usernameless-webauthn/create/complete Finish usernameless WebAuthn credentials generation #
DELETE /system/pools/{ipID}/users/{userID}/webauthn/{webAuthnCredentialID} Delete WebAuthn key #
PUT /system/pools/{ipID}/users/{userID}/webauthn/{webAuthnCredentialID}/name Name WebAuthn key #
POST /system/pools/{ipID}/users/{userID}/webauthn/create/begin Begin WebAuthn credentials generation #
POST /system/pools/{ipID}/users/{userID}/webauthn/create/complete Finish WebAuthn credentials generation #
POST /system/pools/{ipID}/users/by_key Get User Details by key #

Documentation

📖
Documentation
https://docs.secureauth.com/iam/docs/api

Specifications

⚙
OpenAPI
https://artifacts.apis.io/secureauth/openapi/secureauth-users-api-openapi.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • 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.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/secureauth:secureauth-users-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

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.

GitHub Google LinkedIn

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

OpenAPI Specification

secureauth-users-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Secureauth Users API
  version: latest
  description: 'Operations tagged Users across 3 of this provider''s published API definitions: secureauth-identity-openapi.yml, secureauth-identityself-openapi.yml, secureauth-identitysystem-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://localhost:8443/api/identity/default
- url: https://localhost:8443/default/default/identity
tags:


# --- truncated at 32 KB (252 KB total) ---
# Full source: https://artifacts.apis.io/secureauth/openapi/secureauth-users-api-openapi.yml