Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Kiteworks admin API

The admin API from Kiteworks — 19 operation(s) for admin.

Kiteworks admin API is one of 41 APIs that Kiteworks publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include admin. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 29 operations across 19 paths, and defines 38 schemas. It is described by OpenAPI 3.0.2, at version 28.

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

29 operations 19 paths 38 schemas 4 DELETE16 GET4 POST5 PUT

Metadata

The identity and technical contract details declared by the specification.

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

Paths & Operations 29

Across 19 paths, the API surfaces 29 operations — 4 DELETE, 16 GET, 4 POST, 5 PUT. Each is listed below with its method, path, parameters, and response codes.

admin 29
GET
/rest/admin/hostnames
List hostnames
14 params → 200490
DELETE
/rest/admin/hostnames
Deletes list of hostnames
3 params → 204403490
POST
/rest/admin/hostnames
Create an alias hostname
2 params body → 200409422490
GET
/rest/admin/hostnames/{id}
Returns the details of hostname of the specified ID.
1 param → 200490
PUT
/rest/admin/hostnames/{id}
Disable / enable alias hostname
1 param body → 200403490
DELETE
/rest/admin/hostnames/{id}
Mark specified hostname as deleted.
1 param → 204403490
GET
/rest/admin/mail
List emails
25 params → 200490
DELETE
/rest/admin/mail/actions/withdrawFiles/users/{userId}
Withdraw all files from the emails of deleted or demoted users
4 params → 204403490
GET
/rest/admin/profiles
List user types (profiles)
7 params → 200490
GET
/rest/admin/profiles/mappingOrder
Get profile mapping order
→ 200490
PUT
/rest/admin/profiles/mappingOrder
Update profile mapping order
2 params body → 200422490
GET
/rest/admin/profiles/mappings
Get profile mapping results for user
1 param → 200490
GET
/rest/admin/profiles/{id}
Return a user type
1 param → 200490
GET
/rest/admin/profiles/{id}/mappings
Get profile mapping details
1 param → 200490
PUT
/rest/admin/profiles/{id}/mappings
Update profile mapping details
3 params body → 200422490
GET
/rest/admin/profiles/{id}/users
Return list of users with the specified types
24 params → 200403490
PUT
/rest/admin/profiles/{id}/users
Bulk update user types (profiles)
3 params body → 200403422490
GET
/rest/admin/users
Get a list of Users
23 params → 200490
POST
/rest/admin/users
Create a User
2 params body → 200403422490
POST
/rest/admin/users/migrateEmails
Bulk update user emails
2 params body → 200422490
POST
/rest/admin/users/migrateEmailsCsv
Bulk update user emails via CSV file
2 params body → 200422490
GET
/rest/admin/users/{id}
Get User
1 param → 200490
PUT
/rest/admin/users/{id}
Update User
1 param body → 200403490
DELETE
/rest/admin/users/{id}
Deletes a User
11 params → 204403422490
GET
/rest/admin/users/{id}/adminRoles
Return admin roles of the specified user id.
4 params → 200403490
GET
/rest/admin/users/{id}/devices
List devices for a user
12 params → 200490
GET
/rest/admin/activities
Get admin activities list
10 params → 200401422490
GET
/rest/admin/activities/{id}
Get admin activity detail
1 param → 200401422490
GET
/rest/admin/activities/actions/exportCSV
Export admin activities list
10 params → 200401422490

Schemas 38

The contract defines 38 schemas that model the data the API accepts and returns. The most detailed are FeaturesList (58 properties), Email (36 properties), User (22 properties), Attachment (19 properties). Each schema is shown below with its type and property counts.

Errors
object
1 property
FeaturesList
object
Class FeaturesList
58 properties 7 required
Tag
object
3 properties
ProfileMappings
object
Class ProfileMappings
3 properties
UserEmail.Post
object
Class UserEmail
2 properties 2 required
ProfileMappingOrder
object
Class ProfileMappingOrder
2 properties 2 required
Hostname
object
Class Hostname
5 properties 1 required
MetaData
object
3 properties
ProfileMapping
object
Class ProfileMapping
4 properties 1 required
UsersEmailMigration.Post
object
Class UsersEmailMigration
2 properties
ProfileMappingsTest
object
Class ProfileMappingsTest
1 property
UserBasic
object
4 properties
ProfileMappingChanges.Put
object
Class ProfileMappingChanges
2 properties
Attachment
object
19 properties
Recipient
object
5 properties
UserMetadata
object
Class UserMetadata
2 properties
User.Post
object
Class User
7 properties 1 required
Profile
object
Class Profile
6 properties 5 required
Email
object
Class Email
36 properties 10 required
Permission
object
3 properties
UserBasicInfo
object
4 properties 3 required
User.Put
object
Class User
6 properties
Error
object
2 properties
ActivityUser
object
4 properties
Hostname.Put
object
Class Hostname
2 properties
DrmFile
object
2 properties
Fingerprint
object
2 properties
User
object
Class User
22 properties 6 required
ProfileMappingChanges
object
Class ProfileMappingChanges
1 property 1 required
AdminRole
object
Class AdminRole
4 properties 2 required
ActivityList
object
1 property
ProfileMappingOrder.Put
object
Class ProfileMappingOrder
2 properties 1 required
UserDemoteOptions.Post
object
Class UserDemoteOptions
8 properties
EmailReturnReceipt
object
Class Recipient
3 properties 2 required
Package
object
9 properties
Activity
object
9 properties
Hostname.Post
object
Class Hostname
3 properties 1 required
Device
object
Class Device
8 properties 4 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

kiteworks-admin-api-openapi.yml Raw ↑

Other APIs Kiteworks publishes across the network.

Kiteworks activities 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
Kiteworks favorites API