Kiteworks users API
The users API from Kiteworks — 30 operation(s) for users.
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 users. 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.0.2, 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.
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
POST
/rest/users/actions/login
User login
PUT
/rest/users/aliveToken
Updates token state
GET
/rest/users/ldapSearch
Find users in LDAP by input supplied
PUT
/rest/users/me
Update the current user's details
GET
/rest/users/me
Retrieve details of the currently logged-in user
POST
/rest/users/me/forcedPasswordChange
Change the password for current user after expired
PUT
/rest/users/me/mobileNumber
Update mobile number of the current user
GET
/rest/users/me/quota
Retrieve user quota
POST
/rest/users/me/tfa/auth
Two Factor Authentication
POST
/rest/users/me/tfa/challenge
Two Factor Authentication
GET
/rest/users/me/tfa/config
Two Factor Authentication
POST
/rest/users/me/tfa/resetTotpSecret
Reset secret key for time-based OTP of the current user
GET
/rest/users/me/tfa/setupTotpSecret
Setup secret key for Time-based OTP of the current user
POST
/rest/users/me/tfa/verifyTotpSecret
Verify code for finalising secret key for Time-based OTP
PUT
/rest/users/me/tfaSetup
Setup 2FA settings
GET
/rest/users/me/tos
Terms of Service
POST
/rest/users/me/tos
Terms of Service
POST
/rest/users/preauth
User login preauth
POST
/rest/users/register
Register a User
POST
/rest/users/requestPasswordReset
Request for password reset
POST
/rest/users/resetPassword
Reset password
POST
/rest/users/{id}/profileImage
Uploads a profile image
DELETE
/rest/users/{id}/profileImage
Deletes a profile image
GET
/rest/users/{id}/settings
Get User Settings
PUT
/rest/users/{id}/settings
Update User Settings
POST
/rest/users/me/recent
Add objects to user's recent items
GET
/rest/users/me/recent
Return user's recent items
DELETE
/rest/users/me/recent/{id}
Delete a user's recent item
POST
/rest/users/me/pins
Pin items for the current user
DELETE
/rest/users/me/pins
Unpin items for the current user
GET
/rest/users/actions/getDistributionList
Check emails for LDAP distribution list status
GET
/rest/users/me/concurrent/challenge
Get concurrent session challenge
POST
/rest/users/me/concurrent/auth
Resolve a concurrent session challenge
POST
/rest/admin/users/actions/import
Bulk import users via CSV file
POST
/rest/admin/users/actions/deleteTotpSecret
Delete TOTP secrets for users
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.
UserMobileNumberPassword.Put
object
Class UserPassword
3 properties
2 required
Errors
object
1 property
Settings
object
Class Settings
9 properties
RecentObject
object
2 properties
2 required
PushedObject
object
4 properties
UserTfaTotpVerifySecret.Post
object
Class UserTfaTotpVerifySecret
2 properties
1 required
Tag
object
3 properties
AdminDeleteTOTPSecretRequest
object
1 property
1 required
UserMe
object
Class UserMe
15 properties
6 required
AdminUserImportError
object
2 properties
Settings.Put
object
Class Settings
5 properties
UserBasic
object
4 properties
AuthRedirectResponse
object
Represents the success response for authentication flow endpoints that advance the user to the next step.
1 property
UserMetadata
object
Class UserMetadata
2 properties
UserTfaTotpResetSecret.Post
object
Class UserTfaTotpResetSecret
2 properties
1 required
UserNamePassword.Put
object
Class UserNamePassword
3 properties
UserRegister.Post
object
Class UserRegister
5 properties
2 required
TosResponse
object
Represents the Terms of Service content returned for the current user.
5 properties
SystemFolders
object
4 properties
UserMePinsPostRequest
object
2 properties
2 required
UserTos.Post
object
Class UserTos
2 properties
1 required
LdapSearchResults
object
Class LdapSearchResults
1 property
1 required
Permission
object
3 properties
LdapSearchResultUser
object
Class LdapSearchResultUser
2 properties
Folder
object
43 properties
Error
object
2 properties
Role
object
4 properties
File
object
46 properties
AdminUserImport
object
4 properties
UserResetPassword.Post
object
Class UserResetPassword
2 properties
2 required
TfaConfigResponse
object
Represents the Two-Factor Authentication configuration for the current user.
11 properties
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
Fingerprint
object
2 properties
MobileInfo
object
5 properties
PreauthResponse
object
Represents the success response for the preauth endpoint.
4 properties
UserMeConcurrentAuthPostRequest
object
2 properties
2 required
UserDistributionList
object
2 properties
UserQuota
object
5 properties
UserDistributionLists
object
1 property
RecentObjectsPostRequest
object
1 property
1 required
Member
object
14 properties
SafeEdit
object
2 properties
UserMeConcurrentChallenge
object
3 properties
UserTfa.Post
object
Class UserTfa
3 properties
1 required
UserForcedPasswordChange.Put
object
Class UserForcedPasswordChange
3 properties
UserRequestPasswordReset.Post
object
Class UserRequestPasswordReset
1 property
1 required
UserPreauth.Post
object
Class UserPreauth
2 properties
1 required
Group
object
5 properties
TotpSetupResponse
object
Represents the success response when initiating a TOTP secret setup.
6 properties
UserLogin.Post
object
Class UserLogin
3 properties
2 required
LoginResponse
object
Represents the success response for the login endpoint.
2 properties
UserTfa.Put
object
Class UserTfa
3 properties
1 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Kiteworks 12
Other APIs Kiteworks publishes across the network.
Kiteworks activities API
Kiteworks admin API
Kiteworks adminRoles API
Kiteworks advancedForms API
Kiteworks cards API
Kiteworks clientEventLogs API
Kiteworks clients API
Kiteworks comments API
Kiteworks contacts API
Kiteworks devices API
Kiteworks dli API
Kiteworks externalDL API
#users