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
Kiteworks

Kiteworks Users API

The users API from Kiteworks — 30 operation(s) for users.

Documentation Provider Profile APIs.io OpenAPI GitHub

Kiteworks Users API is one of 41 APIs that Kiteworks 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 36 operations across 30 paths, and defines 52 schemas. It is described by OpenAPI 3.2.0, at version 28.

Requests are made against the base URL https://your.kiteworks.domain/rest.

36 operations 30 paths 52 schemas 4 DELETE10 GET17 POST5 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
28
Base URL
https://your.kiteworks.domain/rest
Resource Areas
1

Paths & Operations 36

Across 30 paths, the API surfaces 36 operations — 4 DELETE, 10 GET, 17 POST, 5 PUT. Each is listed below with its method, path, parameters, and response codes.

Users 36
DELETE
/rest/users
Deletes Users
deleteRestUsers 11 params → 204403422490
POST
/rest/users/actions/login
User login
postRestUsersActionsLogin body → 200422490
PUT
/rest/users/aliveToken
Updates token state
putRestUsersAliveToken → 200490
GET
/rest/users/ldapSearch
Find users in LDAP by input supplied
getRestUsersLdapSearch 3 params → 200490
PUT
/rest/users/me
Update the current user's details
putRestUsersMe body → 200422490
GET
/rest/users/me
Retrieve details of the currently logged-in user
getRestUsersMe → 200490
POST
/rest/users/me/forcedPasswordChange
Change the password for current user after expired
postRestUsersMeForcedPasswordChange body → 200422490
PUT
/rest/users/me/mobileNumber
Update mobile number of the current user
putRestUsersMeMobileNumber body → 200422490
GET
/rest/users/me/quota
Retrieve user quota
getRestUsersMeQuota 1 param → 200401404490
POST
/rest/users/me/tfa/auth
Two Factor Authentication
postRestUsersMeTfaAuth body → 200422490
POST
/rest/users/me/tfa/challenge
Two Factor Authentication
postRestUsersMeTfaChallenge 1 param → 200490
GET
/rest/users/me/tfa/config
Two Factor Authentication
getRestUsersMeTfaConfig → 200490
POST
/rest/users/me/tfa/resetTotpSecret
Reset secret key for time-based OTP of the current user
postRestUsersMeTfaResetTotpSecret body → 200422490
GET
/rest/users/me/tfa/setupTotpSecret
Setup secret key for Time-based OTP of the current user
getRestUsersMeTfaSetupTotpSecret → 200490
POST
/rest/users/me/tfa/verifyTotpSecret
Verify code for finalising secret key for Time-based OTP
postRestUsersMeTfaVerifyTotpSecret body → 200422490
PUT
/rest/users/me/tfaSetup
Setup 2FA settings
putRestUsersMeTfaSetup body → 200403490
GET
/rest/users/me/tos
Terms of Service
getRestUsersMeTos → 200490
POST
/rest/users/me/tos
Terms of Service
postRestUsersMeTos body → 200422490
POST
/rest/users/preauth
User login preauth
postRestUsersPreauth body → 200403422490
POST
/rest/users/register
Register a User
postRestUsersRegister body → 204403422490
POST
/rest/users/requestPasswordReset
Request for password reset
postRestUsersRequestPasswordReset body → 204403422490
POST
/rest/users/resetPassword
Reset password
postRestUsersResetPassword body → 204403422490
POST
/rest/users/{id}/profileImage
Uploads a profile image
postRestUsersByIdProfileImage 1 param body → 200403490
DELETE
/rest/users/{id}/profileImage
Deletes a profile image
deleteRestUsersByIdProfileImage 1 param → 200403490
GET
/rest/users/{id}/settings
Get User Settings
getRestUsersByIdSettings 1 param → 200403490
PUT
/rest/users/{id}/settings
Update User Settings
putRestUsersByIdSettings 1 param body → 200403490
POST
/rest/users/me/recent
Add objects to user's recent items
postRestUsersMeRecent body → 201207400401422490
GET
/rest/users/me/recent
Return user's recent items
getRestUsersMeRecent 4 params → 200401490
DELETE
/rest/users/me/recent/{id}
Delete a user's recent item
deleteRestUsersMeRecentById 1 param → 204401490
POST
/rest/users/me/pins
Pin items for the current user
postRestUsersMePins body → 204400401403422490
DELETE
/rest/users/me/pins
Unpin items for the current user
deleteRestUsersMePins body → 204400401422490
GET
/rest/users/actions/getDistributionList
Check emails for LDAP distribution list status
getRestUsersActionsGetDistributionList 1 param → 200401403490
GET
/rest/users/me/concurrent/challenge
Get concurrent session challenge
getRestUsersMeConcurrentChallenge → 200401403490
POST
/rest/users/me/concurrent/auth
Resolve a concurrent session challenge
postRestUsersMeConcurrentAuth body → 200401403490
POST
/rest/admin/users/actions/import
Bulk import users via CSV file
postRestAdminUsersActionsImport body → 200401403422490
POST
/rest/admin/users/actions/deleteTotpSecret
Delete TOTP secrets for users
postRestAdminUsersActionsDeleteTotpSecret body → 200401403404422490

Schemas 52

The contract defines 52 schemas that model the data the API accepts and returns. The most detailed are File (46 properties), Folder (43 properties), UserMe (15 properties), Member (14 properties). Each schema is shown below with its type and property counts.

UserBasic
object
4 properties
Member
object
14 properties
Error
object
2 properties
UserTfa.Put
object
Class UserTfa
3 properties 1 required
PreauthResponse
object
Represents the success response for the preauth endpoint.
4 properties
TotpSetupResponse
object
Represents the success response when initiating a TOTP secret setup.
6 properties
LdapSearchResults
object
Class LdapSearchResults
1 property 1 required
UserLogin.Post
object
Class UserLogin
3 properties 2 required
Permission
object
3 properties
RecentObjectsPostRequest
object
1 property 1 required
Settings.Put
object
Class Settings
5 properties
Folder
object
43 properties
MobileInfo
object
5 properties
UserResetPassword.Post
object
Class UserResetPassword
2 properties 2 required
TfaConfigResponse
object
Represents the Two-Factor Authentication configuration for the current user.
11 properties
LdapSearchResultUser
object
Class LdapSearchResultUser
2 properties
Settings
object
Class Settings
9 properties
UserRegister.Post
object
Class UserRegister
5 properties 2 required
UserRequestPasswordReset.Post
object
Class UserRequestPasswordReset
1 property 1 required
SafeEdit
object
2 properties
UserMePinsPostRequest
object
2 properties 2 required
UserTfaTotpVerifySecret.Post
object
Class UserTfaTotpVerifySecret
2 properties 1 required
UserMetadata
object
Class UserMetadata
2 properties
UserTfaTotpResetSecret.Post
object
Class UserTfaTotpResetSecret
2 properties 1 required
UserTos.Post
object
Class UserTos
2 properties 1 required
AdminDeleteTOTPSecretRequest
object
1 property 1 required
UserMobileNumberPassword.Put
object
Class UserPassword
3 properties 2 required
SystemFolders
object
4 properties
UserMeConcurrentChallenge
object
3 properties
AdminUserImportError
object
2 properties
Tag
object
3 properties
AuthRedirectResponse
object
Represents the success response for authentication flow endpoints that advance the user to the next step.
1 property
UserMe
object
Class UserMe
15 properties 6 required
Fingerprint
object
2 properties
UserMeConcurrentAuthPostRequest
object
2 properties 2 required
TfaChallengeResponse
object
Represents the success response for TFA challenge and auth endpoints. Exactly one of the two properties is present in any given response.
2 properties
LoginResponse
object
Represents the success response for the login endpoint.
2 properties
UserQuota
object
5 properties
Role
object
4 properties
UserForcedPasswordChange.Put
object
Class UserForcedPasswordChange
3 properties
File
object
46 properties
UserDistributionList
object
2 properties
UserTfa.Post
object
Class UserTfa
3 properties 1 required
UserDistributionLists
object
1 property
RecentObject
object
2 properties 2 required
AdminUserImport
object
4 properties
UserPreauth.Post
object
Class UserPreauth
2 properties 1 required
TosResponse
object
Represents the Terms of Service content returned for the current user.
5 properties
UserNamePassword.Put
object
Class UserNamePassword
3 properties
PushedObject
object
4 properties
Group
object
5 properties
Errors
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

kiteworks-users-api-openapi.yml Raw ↑

Other APIs Kiteworks publishes across the network.

Kiteworks Activities API
AE Profile APIs.io
Kiteworks Admin API
AE Profile APIs.io
Kiteworks Advanced Forms API
AE Profile APIs.io
Kiteworks Cards API
AE Profile APIs.io
Kiteworks Client Event Logs API
AE Profile APIs.io
Kiteworks Clients API
AE Profile APIs.io
Kiteworks Comments API
AE Profile APIs.io
Kiteworks Contacts API
AE Profile APIs.io
Kiteworks Devices API
AE Profile APIs.io
Kiteworks Dli API
AE Profile APIs.io
Kiteworks External DL API
AE Profile APIs.io
Kiteworks Favorites API
AE Profile APIs.io
#User
← Back to K APIs
API Details
ID
kiteworks:kiteworks-users-api
Base URL
https://your.kiteworks.domain/rest
Docs
https://developer.kiteworks.com/api-endpoints.html
Provider
Kiteworks
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=kiteworks-users-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/kiteworks-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 Kiteworks 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.