List hostnames
Returns a paginated list of all alias hostnames, including their hostname, disabled state, and deletion status.
Alias name
Alias name. Search for results that contain the specified characters in this parameter.
Tenant ID
Tenant ID. Search for results where this parameter value is greater than the specified value.
Tenant ID. Search for results where this parameter value is greater than or equal to the specified value.
Tenant ID. Search for results where this parameter value is less than the specified value.
Tenant ID. Search for results where this parameter value is less than or equal to the specified value.
Filter by whether the hostname is deleted.
Filter by whether the hostname is disabled.
Sorting options
Offset
Limit
With parameters
Determines the detail level of the response body.
List of hostnames retrieved successfully.
Hostname unique identifier
Hostname
Indicates whether the hostname is deleted
Indicates whether the hostname is disabled
HATEOAS links associated with the entity
Total number of items available.
Maximum number of items returned per page.
Number of items skipped before the current page.
Request blocked by WAF
curl -X GET \
"https://{instance}.kiteworks.com/rest/admin/hostnames" \
-H "Authorization: Bearer YOUR_TOKEN"import requests
url = "https://{instance}.kiteworks.com/rest/admin/hostnames"
headers = {
"Authorization": "Bearer YOUR_TOKEN",
}
response = requests.get(url, headers=headers)
print(response.json())Create an alias hostname
Creates a new alias hostname for the current tenant. The hostname must be a valid subdomain of the configured site domain and must not already exist.
If set to true, returns information about the newly created entity.
Determines the detail level of the response body.
Hostname
Disable hostname
Indicates whether HATEOAS links should be included in the response
Hostname created successfully.
Hostname unique identifier
Hostname
Indicates whether the hostname is deleted
Indicates whether the hostname is disabled
HATEOAS links associated with the entity
Conflict
Possible error codes: ERR_ENTITY_EXISTS
Error code
Error message
Unprocessable Content
Possible error codes: ERR_INPUT_REQUIRED, ERR_INPUT_NOT_BOOLEAN
Error code
Error message
Request blocked by WAF
curl -X POST \
"https://{instance}.kiteworks.com/rest/admin/hostnames" \
-H "Authorization: Bearer YOUR_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"hostname": "string",
"disabled": true,
"addLinks": true
}'import requests
url = "https://{instance}.kiteworks.com/rest/admin/hostnames"
headers = {
"Authorization": "Bearer YOUR_TOKEN",
"Content-Type": "application/json",
}
payload = {
"hostname": "string",
"disabled": true,
"addLinks": true
}
response = requests.post(url, headers=headers, json=payload)
print(response.json())Deletes list of hostnames
Soft-deletes a list of hostnames in a single request. Supports partial success, meaning valid items are processed even if some fail.
A comma-separated list of unique identifiers for the entities to be processed.. A comma-separated list of unique identifiers for the entities to be processed.
If set to true, the operation will continue for the valid items even if some items result in failure.
Determines the detail level of the response body.
Hostnames deleted successfully.
Forbidden
Possible error codes: ERR_ACCESS_USER
Error code
Error message
Request blocked by WAF
curl -X DELETE \
"https://{instance}.kiteworks.com/rest/admin/hostnames?id:in=VALUE" \
-H "Authorization: Bearer YOUR_TOKEN"import requests
url = "https://{instance}.kiteworks.com/rest/admin/hostnames"
headers = {
"Authorization": "Bearer YOUR_TOKEN",
}
params = {
"id:in": "VALUE",
}
response = requests.delete(url, params=params, headers=headers)
print(response.json())Returns the details of hostname of the specified ID.
Returns the hostname record identified by the given ID, including its hostname value, disabled state, and deletion status.
ID of the hostname to be retrieved
Hostname details retrieved successfully.
Hostname unique identifier
Hostname
Indicates whether the hostname is deleted
Indicates whether the hostname is disabled
HATEOAS links associated with the entity
Request blocked by WAF
curl -X GET \
"https://{instance}.kiteworks.com/rest/admin/hostnames/:id" \
-H "Authorization: Bearer YOUR_TOKEN"import requests
id = "VALUE" # ID of the hostname to be retrieved
url = f"https://{{instance}}.kiteworks.com/rest/admin/hostnames/{id}"
headers = {
"Authorization": "Bearer YOUR_TOKEN",
}
response = requests.get(url, headers=headers)
print(response.json())Disable / enable alias hostname
Updates the disabled state of the specified hostname, allowing it to be enabled or disabled.
ID of the hostname to disable
Disable hostname
Indicates whether HATEOAS links should be included in the response
Hostname updated successfully.
Hostname unique identifier
Hostname
Indicates whether the hostname is deleted
Indicates whether the hostname is disabled
HATEOAS links associated with the entity
Forbidden
Possible error codes: ERR_ACCESS_USER
Error code
Error message
Request blocked by WAF
curl -X PUT \
"https://{instance}.kiteworks.com/rest/admin/hostnames/:id" \
-H "Authorization: Bearer YOUR_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"disabled": true,
"addLinks": true
}'import requests
id = "VALUE" # ID of the hostname to disable
url = f"https://{{instance}}.kiteworks.com/rest/admin/hostnames/{id}"
headers = {
"Authorization": "Bearer YOUR_TOKEN",
"Content-Type": "application/json",
}
payload = {
"disabled": true,
"addLinks": true
}
response = requests.put(url, headers=headers, json=payload)
print(response.json())Mark specified hostname as deleted.
Soft-deletes the specified hostname by marking it as deleted. The record is retained but treated as inactive.
ID of the hostname
Hostname marked as deleted successfully.
Forbidden
Possible error codes: ERR_ACCESS_USER
Error code
Error message
Request blocked by WAF
curl -X DELETE \
"https://{instance}.kiteworks.com/rest/admin/hostnames/:id" \
-H "Authorization: Bearer YOUR_TOKEN"import requests
id = "VALUE" # ID of the hostname
url = f"https://{{instance}}.kiteworks.com/rest/admin/hostnames/{id}"
headers = {
"Authorization": "Bearer YOUR_TOKEN",
}
response = requests.delete(url, headers=headers)
print(response.json())List emails
Returns a list of emails for any user in the system. This includes sent emails, received emails, draft emails, and request a file emails. Requires admin privileges.
Unique identifier of User who sent Email
Unique identifier of User who sent Email. Search for results that match any of the specified values for this parameter.
Email creation date
Email creation date. Search for results where this parameter value is greater than the specified value.
Email creation date. Search for results where this parameter value is greater than or equal to the specified value.
Email creation date. Search for results where this parameter value is less than the specified value.
Email creation date. Search for results where this parameter value is less than or equal to the specified value.
Email modification date
Email modification date. Search for results where this parameter value is greater than the specified value.
Email modification date. Search for results where this parameter value is greater than or equal to the specified value.
Email modification date. Search for results where this parameter value is less than the specified value.
Email modification date. Search for results where this parameter value is less than or equal to the specified value.
Filter emails based on whether they have been deleted.
Email Package unique identifier
Email Package unique identifier. Search for results that match any of the specified values for this parameter.
Email Template unique identifier
Email Template unique identifier. Search for results that match any of the specified values for this parameter.
Filter emails by status. Accepted values: sent, draft, queued, error, self_send, transferring.
Whether the email is a preview email
Whether the email was sent by some user
Email web form ID
Email web form ID. Search for results that contain the specified characters in this parameter.
Sorting options
Offset
Limit
Returns a paginated list of emails matching the specified filters.
Email unique identifier
Unique identifier of User who sent Email
Email template unique identifier
Email status. Accepted values: sent, draft, queued, transferring, error, self_send
Email type. Accepted values: original, resend, forward, reply
Date and time the email was created
Indicates whether the email is deleted
Email Package unique identifier
Indicates whether the email is a preview email
Indicates whether the email was sent by a user
The watermark on the preview email
Unique identifier of the email package.
Indicates whether the package includes a copy for the sender.
Indicates whether a fingerprint (hash) of the package should be included for verification.
Expiration time of the package in seconds from creation.
Count of the files attached to the package.
Indicates whether the package has been marked as deleted.
Access control list (ACL) associated with the package, specifying who can access it.
Unique identifier for the email package containing the attachment.
Unique identifier for the attachment.
Indicates whether the attachment has been withdrawn.
Details of the DRM-protected file associated with the attachment.
Access type for the attachment (e.g., read-only, editable).
List of tags associated with the attachment.
List of permissions associated with the attachment.
Unique identifier for the file associated with the attachment.
Name of the attachment file.
Size of the attachment file in bytes.
The MIME type of the attachment file.
Date when the attachment file was created.
Indicates if the attachment has been deleted.
A unique hash identifying the file version.
The algorithm used for generating the file version fingerprint. (e.g., sha3-256, md5).
List of alternative fingerprints for the attachment file.
Status of the attachment in the admin quarantine system.
Antivirus (AV) scan status of the attachment.
Data Loss Prevention (DLP) status of the attachment.
Link for accessing the email.
Email package expiration date
Number of attachments in the email package
The unique identifier of the user
The name of the user
The user's email
URL to the user's profile icon image
Unique identifier of the user associated with the recipient.
Recipient type.0 – To.1 – CC.2 – BCC.
Email address of the recipient.
Indicates if the recipient is a distribution list rather than an individual user.
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
Indicates whether the email body is secured
Date and time the email was last modified
Unique identifier of the original email this email was forwarded or replied from
Email unique identifier for return receipt
The unique identifier of the user
The name of the user
The user's email
URL to the user's profile icon image
User ID for Return Receipt
Error message when the email status is error
Subject line of the email as shown to recipients
(Explicit field. May be retrieved only if mentioned in "with" parameter)
(Explicit field. May be retrieved only if mentioned in "with" parameter)
(Explicit field. May be retrieved only if mentioned in "with" parameter)
(Explicit field. May be retrieved only if mentioned in "with" parameter)
(Explicit field. May be retrieved only if mentioned in "with" parameter)
(Explicit field. May be retrieved only if mentioned in "with" parameter)
(Explicit field. May be retrieved only if mentioned in "with" parameter)
Indicates whether the email has been read by the current user
Mailbox bucket the email belongs to. Accepted values: inbox, sent, draft, outgoing, trash
(Explicit field. May be retrieved only if mentioned in "with" parameter)
(Explicit field. May be retrieved only if mentioned in "with" parameter)
(Explicit field. May be retrieved only if mentioned in "with" parameter)
HATEOAS links associated with the entity
Total number of items available.
Maximum number of items returned per page.
Number of items skipped before the current page.
Request blocked by WAF
curl -X GET \
"https://{instance}.kiteworks.com/rest/admin/mail" \
-H "Authorization: Bearer YOUR_TOKEN"import requests
url = "https://{instance}.kiteworks.com/rest/admin/mail"
headers = {
"Authorization": "Bearer YOUR_TOKEN",
}
response = requests.get(url, headers=headers)
print(response.json())Withdraw all files from the emails of deleted or demoted users
Withdraws all files from the emails of users who have been deleted or demoted.
The unique identifier of the user from whom to withdraw files.
A list of email IDs to be processed.
If set to true, the operation will continue for the valid items even if some items result in failure.
Determines the detail level of the response body.
The files were successfully withdrawn from the specified emails. No content is returned.
Forbidden
Possible error codes: ERR_ACCESS_USER
Error code
Error message
Request blocked by WAF
curl -X DELETE \
"https://{instance}.kiteworks.com/rest/admin/mail/actions/withdrawFiles/users/:userId" \
-H "Authorization: Bearer YOUR_TOKEN"import requests
userId = "VALUE" # The unique identifier of the user from whom to withdraw files.
url = f"https://{{instance}}.kiteworks.com/rest/admin/mail/actions/withdrawFiles/users/{userId}"
headers = {
"Authorization": "Bearer YOUR_TOKEN",
}
response = requests.delete(url, headers=headers)
print(response.json())List user types (profiles)
Returns a paginated list of user type profiles configured in the system (e.g., Standard and Restricted), including each profile's name, built-in status, and cloneability.
Profile name
Profile name. Search for results that contain the specified characters in this parameter.
Sorting options
Offset
Limit
With parameters
Determines the detail level of the response body.
List of user type profiles retrieved successfully.
Unique Profile identifier
Display name of the profile
Prototype Profile identifier
Indicates whether the profile is a built-in profile
Indicates whether the profile can be used as a prototype for new custom profiles
Indicates whether SFTP access is allowed
Max storage in bytes
Link expiration date in days
Max time period of link expiration in hours
Enable user to set expiration date of the file they are sending
Allow user to send files to external users
Allow user to send file to a user without their having to authenticate
Indicates whether the user is permitted to create top-level folders
Role options allowed for user profile
Indicates whether the user is permitted to create system quota folders
Max quota for a system quota folder
Maximum number of system quota folder
Default quota for a system quota folder
Maximum storage space allocated to the user, in bytes
LDAP Mapping value to determine the user profile type
Who can download file via the secure link
List of access control levels permitted for this user profile
Default access control level applied when sending files for this user profile
Maximum files amount allowed to keep in mobile sync list
User can have personal folder
Indicates whether scanning compressed file content is required by default
Indicates whether new or unspecified file types are blocked by default
Get list of excluded file extensions
Get list of excluded file groups
Get list of custom file types
Indicates whether Collaboration and Shared Folders are allowed
Indicates whether Collaboration and Shared Folders are allowed
Upper limit allowed for number of attachments per mail.
Get profile max folder expiration
Get profile max file lifetime
Total number of items available.
Maximum number of items returned per page.
Number of items skipped before the current page.
Request blocked by WAF
curl -X GET \
"https://{instance}.kiteworks.com/rest/admin/profiles" \
-H "Authorization: Bearer YOUR_TOKEN"import requests
url = "https://{instance}.kiteworks.com/rest/admin/profiles"
headers = {
"Authorization": "Bearer YOUR_TOKEN",
}
response = requests.get(url, headers=headers)
print(response.json())Get profile mapping order
Returns the current ordering of user type profiles used to determine which profile is applied to a user on login when multiple mapping rules match.
Profile mapping order retrieved successfully.
Get the User Profile mapping order
Get the User Profile mapping order
Request blocked by WAF
curl -X GET \
"https://{instance}.kiteworks.com/rest/admin/profiles/mappingOrder" \
-H "Authorization: Bearer YOUR_TOKEN"import requests
url = "https://{instance}.kiteworks.com/rest/admin/profiles/mappingOrder"
headers = {
"Authorization": "Bearer YOUR_TOKEN",
}
response = requests.get(url, headers=headers)
print(response.json())Update profile mapping order
Updates the ordering of user type profiles used to determine which profile is applied to a user on login when multiple mapping rules match. When the peek parameter is set, returns the projected impact without applying changes.
With parameters
Determines the detail level of the response body.
Set if we are peeking into the impact
Set the User Profile mapping order
Profile mapping order updated successfully.
Get the User Profile mapping order
Get the User Profile mapping order
Unprocessable Content
Possible error codes: ERR_INPUT_NOT_BOOLEAN, ERR_INPUT_NOT_ARRAY_OF_INTEGERS, ERR_INPUT_REQUIRED
Error code
Error message
Request blocked by WAF
curl -X PUT \
"https://{instance}.kiteworks.com/rest/admin/profiles/mappingOrder" \
-H "Authorization: Bearer YOUR_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"peek": true,
"order": [
1
]
}'import requests
url = "https://{instance}.kiteworks.com/rest/admin/profiles/mappingOrder"
headers = {
"Authorization": "Bearer YOUR_TOKEN",
"Content-Type": "application/json",
}
payload = {
"peek": true,
"order": [
1
]
}
response = requests.put(url, headers=headers, json=payload)
print(response.json())Get profile mapping results for user
Simulates profile mapping evaluation for the specified user and returns which profile mapping rules would match, without applying any changes.
Username or email of the user to test mappings for
Profile mapping test results retrieved successfully.
Get the User Profile mapping order
Get the id of the target authentication source
Get the name of the target authentication source
Get the filter of the target authentication source
Request blocked by WAF
curl -X GET \
"https://{instance}.kiteworks.com/rest/admin/profiles/mappings?user=VALUE" \
-H "Authorization: Bearer YOUR_TOKEN"import requests
url = "https://{instance}.kiteworks.com/rest/admin/profiles/mappings"
headers = {
"Authorization": "Bearer YOUR_TOKEN",
}
params = {
"user": "VALUE",
}
response = requests.get(url, params=params, headers=headers)
print(response.json())Return a user type
Returns the details of the specified user type profile, including its name, built-in status, and cloneability.
ID of the user type (profile) to be retrieved
User type profile details retrieved successfully.
Unique Profile identifier
Display name of the profile
Prototype Profile identifier
Indicates whether the profile is a built-in profile
Indicates whether the profile can be used as a prototype for new custom profiles
Indicates whether SFTP access is allowed
Max storage in bytes
Link expiration date in days
Max time period of link expiration in hours
Enable user to set expiration date of the file they are sending
Allow user to send files to external users
Allow user to send file to a user without their having to authenticate
Indicates whether the user is permitted to create top-level folders
Role options allowed for user profile
Indicates whether the user is permitted to create system quota folders
Max quota for a system quota folder
Maximum number of system quota folder
Default quota for a system quota folder
Maximum storage space allocated to the user, in bytes
LDAP Mapping value to determine the user profile type
Who can download file via the secure link
List of access control levels permitted for this user profile
Default access control level applied when sending files for this user profile
Maximum files amount allowed to keep in mobile sync list
User can have personal folder
Indicates whether scanning compressed file content is required by default
Indicates whether new or unspecified file types are blocked by default
Get list of excluded file extensions
Get list of excluded file groups
Get list of custom file types
Indicates whether Collaboration and Shared Folders are allowed
Indicates whether Collaboration and Shared Folders are allowed
Upper limit allowed for number of attachments per mail.
Get profile max folder expiration
Get profile max file lifetime
Request blocked by WAF
curl -X GET \
"https://{instance}.kiteworks.com/rest/admin/profiles/:id" \
-H "Authorization: Bearer YOUR_TOKEN"import requests
id = "VALUE" # ID of the user type (profile) to be retrieved
url = f"https://{{instance}}.kiteworks.com/rest/admin/profiles/{id}"
headers = {
"Authorization": "Bearer YOUR_TOKEN",
}
response = requests.get(url, headers=headers)
print(response.json())Get profile mapping details
Returns the identity provider mapping rules configured for the specified profile, including LDAP, SSO, and kiteworks-based filter policies.
ID of the profile to get mapping details for
Profile mapping details retrieved successfully.
Get the User Profile mapping order
Get the id of the target authentication source
Get the name of the target authentication source
Get the filter of the target authentication source
Get the User Profile mapping order
Get the id of the target authentication source
Get the name of the target authentication source
Get the filter of the target authentication source
Get the User Profile mapping order
Get the id of the target authentication source
Get the name of the target authentication source
Get the filter of the target authentication source
Request blocked by WAF
curl -X GET \
"https://{instance}.kiteworks.com/rest/admin/profiles/:id/mappings" \
-H "Authorization: Bearer YOUR_TOKEN"import requests
id = "VALUE" # ID of the profile to get mapping details for
url = f"https://{{instance}}.kiteworks.com/rest/admin/profiles/{id}/mappings"
headers = {
"Authorization": "Bearer YOUR_TOKEN",
}
response = requests.get(url, headers=headers)
print(response.json())Update profile mapping details
Updates the identity provider mapping rules for the specified profile. When the peek parameter is set, returns the projected impact of the changes without applying them.
ID of the profile to update mapping details for
With parameters
Determines the detail level of the response body.
Set if we are peeking into the impact
policy changes to be tested/applied
Profile mapping details updated successfully.
Get the User Profile mapping order
Unprocessable Content
Possible error codes: ERR_INPUT_NOT_BOOLEAN
Error code
Error message
Request blocked by WAF
curl -X PUT \
"https://{instance}.kiteworks.com/rest/admin/profiles/:id/mappings" \
-H "Authorization: Bearer YOUR_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"peek": true,
"changes": [
{
"impact": [
"..."
],
"id": "string",
"name": "string",
"filter": "string"
}
]
}'import requests
id = "VALUE" # ID of the profile to update mapping details for
url = f"https://{{instance}}.kiteworks.com/rest/admin/profiles/{id}/mappings"
headers = {
"Authorization": "Bearer YOUR_TOKEN",
"Content-Type": "application/json",
}
payload = {
"peek": true,
"changes": [
{
"impact": [
"..."
],
"id": "string",
"name": "string",
"filter": "string"
}
]
}
response = requests.put(url, headers=headers, json=payload)
print(response.json())Return list of users with the specified types
Returns a paginated list of users assigned to the specified user type profile (e.g., all Restricted users), including their names and email addresses.
ID of the user type (profile) to retrieve users for
Filter users based on their email address.
Filter users based on their email address.. Search for results that contain the specified characters in this parameter.
Filter users based on their full name.
Filter users based on their full name.. Search for results that contain the specified characters in this parameter.
Filter users based on their metadata information.
Filter users whose metadata contains the specified characters.
Filter users based on whether they have been deleted.
Filter users based on whether they are active in the system.
Filter users based on their verification status.
Filter users based on whether they are suspended.
Filter users who are recipients of specific items.
Filter users whose profiles allow collaboration access.
Filter users based on the creation date of their account.
Filter users based on the creation date of their account.. Search for results where this parameter value is greater than the specified value.
Filter users based on the creation date of their account.. Search for results where this parameter value is greater than or equal to the specified value.
Filter users based on the creation date of their account.. Search for results where this parameter value is less than the specified value.
Filter users based on the creation date of their account.. Search for results where this parameter value is less than or equal to the specified value.
Sorting options
Offset
Limit
If specified, "offset" parameter will be ignored
and the page containing entity with this Id will be returned.
With parameters
Determines the detail level of the response body.
List of users with the specified profile retrieved successfully.
The unique identifier of the user
The unique identifier of the user's root Kiteworks directory.
Date and time the user account was created
The user's email
The unique identifier of the user's mydir system directory.
The name of the user
The unique identifier of the user's 'My Folder'.
The unique identifier of the user type (profile).
Indicates whether the user is an internal user
URL to the user's profile icon image
Indicates whether the user is an External Distribution List
Key name of the custom metadata attribute associated with the user
Value assigned to the custom metadata attribute for the user
The ID of the admin role assigned to the user.
HATEOAS links associated with the entity
Indicates whether the user is an actual kitework user
Indicates whether the user is suspended
Indicates whether the user has been deleted
Authentication type.
- 0: No authentication,
- 1: Authentication by kiteworks,
- 2: Authentication by LDAP,
- 4: Authentication by SSO
Indicates whether the user is verified
Indicates whether the user has been deactivated
User's last activity datetime
The exact timestamp when the user's password will expire
Total number of items available.
Maximum number of items returned per page.
Number of items skipped before the current page.
Forbidden
Possible error codes: ERR_ACCESS_USER
Error code
Error message
Request blocked by WAF
curl -X GET \
"https://{instance}.kiteworks.com/rest/admin/profiles/:id/users" \
-H "Authorization: Bearer YOUR_TOKEN"import requests
id = "VALUE" # ID of the user type (profile) to retrieve users for
url = f"https://{{instance}}.kiteworks.com/rest/admin/profiles/{id}/users"
headers = {
"Authorization": "Bearer YOUR_TOKEN",
}
response = requests.get(url, headers=headers)
print(response.json())Bulk update user types (profiles)
Reassigns multiple users to the specified user type profile. When demoting users to a Restricted or Recipient profile, optional demotion settings control how existing data is handled (retained, deleted, or transferred to another user).
ID of the user type (profile).
A comma-separated list of unique identifiers for the entities to be processed.. A comma-separated list of user IDs to be assigned to the user type (profile).
Determines the detail level of the response body.
Indicates whether to remotely wipe data from both desktop and mobile devices.
Indicates whether data owned by the user should be deleted. This is required and must be set to True if retainData is False, and vice versa.
Indicates whether data should be retained and transferred to another user. This is required and must be True if deleteUnsharedData is False, and vice versa.
The ID of the new owner to whom the data will be transferred, applicable when retainData and/or retainPermissionToSharedData are set to true.
The ID of the user to whom the advanced form data will be transferred, similar to retainToUser but specifically for advanced form components.
Indicates whether permissions to shared folder should be retained.
Indicates whether request files should be withdrawn.
Indicates whether sent files should be withdrawn.
User profiles updated successfully.
The unique identifier of the user
The unique identifier of the user's root Kiteworks directory.
Date and time the user account was created
The user's email
The unique identifier of the user's mydir system directory.
The name of the user
The unique identifier of the user's 'My Folder'.
The unique identifier of the user type (profile).
Indicates whether the user is an internal user
URL to the user's profile icon image
Indicates whether the user is an External Distribution List
Key name of the custom metadata attribute associated with the user
Value assigned to the custom metadata attribute for the user
The ID of the admin role assigned to the user.
HATEOAS links associated with the entity
Indicates whether the user is an actual kitework user
Indicates whether the user is suspended
Indicates whether the user has been deleted
Authentication type.
- 0: No authentication,
- 1: Authentication by kiteworks,
- 2: Authentication by LDAP,
- 4: Authentication by SSO
Indicates whether the user is verified
Indicates whether the user has been deactivated
User's last activity datetime
The exact timestamp when the user's password will expire
Total number of items available.
Maximum number of items returned per page.
Number of items skipped before the current page.
Forbidden
Possible error codes: ERR_ACCESS_USER
Error code
Error message
Unprocessable Content
Possible error codes: ERR_INPUT_NOT_BOOLEAN, ERR_INPUT_ATTRIBUTE_FORBIDDEN, ERR_INPUT_REQUIRED, ERR_INPUT_NOT_STRING
Error code
Error message
Request blocked by WAF
curl -X PUT \
"https://{instance}.kiteworks.com/rest/admin/profiles/:id/users?id:in=VALUE" \
-H "Authorization: Bearer YOUR_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"remoteWipe": true,
"deleteUnsharedData": true,
"retainData": true,
"retainToUser": "string",
"retainToAdvancedFormUser": "string",
"retainPermissionToSharedData": true
}'import requests
id = "VALUE" # ID of the user type (profile).
url = f"https://{{instance}}.kiteworks.com/rest/admin/profiles/{id}/users"
headers = {
"Authorization": "Bearer YOUR_TOKEN",
"Content-Type": "application/json",
}
params = {
"id:in": "VALUE",
}
payload = {
"remoteWipe": true,
"deleteUnsharedData": true,
"retainData": true,
"retainToUser": "string",
"retainToAdvancedFormUser": "string",
"retainPermissionToSharedData": true
}
response = requests.put(url, params=params, headers=headers, json=payload)
print(response.json())Get a list of Users
Returns a list of Users in the system. The user must be an administrator with access to User Management.
Filter users based on their email address.
Filter users based on their email address.. Search for results that contain the specified characters in this parameter.
Filter users based on their full name.
Filter users based on their full name.. Search for results that contain the specified characters in this parameter.
Filter users based on their metadata information.
Filter users whose metadata contains the specified characters.
Filter users based on whether they have been deleted.
Filter users based on whether they are active in the system.
Filter users based on their verification status.
Filter users based on whether they are suspended.
Filter users who are recipients of specific items.
Filter users whose profiles allow collaboration access.
Filter users based on the creation date of their account.
Filter users based on the creation date of their account.. Search for results where this parameter value is greater than the specified value.
Filter users based on the creation date of their account.. Search for results where this parameter value is greater than or equal to the specified value.
Filter users based on the creation date of their account.. Search for results where this parameter value is less than the specified value.
Filter users based on the creation date of their account.. Search for results where this parameter value is less than or equal to the specified value.
Sorting options
Offset
Limit
If specified, "offset" parameter will be ignored
and the page containing entity with this Id will be returned.
With parameters
Determines the detail level of the response body.
Returns a paginated list of users.
The unique identifier of the user
The unique identifier of the user's root Kiteworks directory.
Date and time the user account was created
The user's email
The unique identifier of the user's mydir system directory.
The name of the user
The unique identifier of the user's 'My Folder'.
The unique identifier of the user type (profile).
Indicates whether the user is an internal user
URL to the user's profile icon image
Indicates whether the user is an External Distribution List
Key name of the custom metadata attribute associated with the user
Value assigned to the custom metadata attribute for the user
The ID of the admin role assigned to the user.
HATEOAS links associated with the entity
Indicates whether the user is an actual kitework user
Indicates whether the user is suspended
Indicates whether the user has been deleted
Authentication type.
- 0: No authentication,
- 1: Authentication by kiteworks,
- 2: Authentication by LDAP,
- 4: Authentication by SSO
Indicates whether the user is verified
Indicates whether the user has been deactivated
User's last activity datetime
The exact timestamp when the user's password will expire
Total number of items available.
Maximum number of items returned per page.
Number of items skipped before the current page.
Request blocked by WAF
curl -X GET \
"https://{instance}.kiteworks.com/rest/admin/users" \
-H "Authorization: Bearer YOUR_TOKEN"import requests
url = "https://{instance}.kiteworks.com/rest/admin/users"
headers = {
"Authorization": "Bearer YOUR_TOKEN",
}
response = requests.get(url, headers=headers)
print(response.json())Create a User
Creates a new User in the system by specifying an email address and name.
If set to true, returns information about the newly created entity.
Determines the detail level of the response body.
The user's email
The name of the user
The user's password
The unique identifier of the user type
Indicates whether the user is verified
Indicates whether a notification is sent to the user
Indicates whether HATEOAS links should be included in the response
User created successfully. Returns the newly created user object.
The unique identifier of the user
The unique identifier of the user's root Kiteworks directory.
Date and time the user account was created
The user's email
The unique identifier of the user's mydir system directory.
The name of the user
The unique identifier of the user's 'My Folder'.
The unique identifier of the user type (profile).
Indicates whether the user is an internal user
URL to the user's profile icon image
Indicates whether the user is an External Distribution List
Key name of the custom metadata attribute associated with the user
Value assigned to the custom metadata attribute for the user
The ID of the admin role assigned to the user.
HATEOAS links associated with the entity
Indicates whether the user is an actual kitework user
Indicates whether the user is suspended
Indicates whether the user has been deleted
Authentication type.
- 0: No authentication,
- 1: Authentication by kiteworks,
- 2: Authentication by LDAP,
- 4: Authentication by SSO
Indicates whether the user is verified
Indicates whether the user has been deactivated
User's last activity datetime
The exact timestamp when the user's password will expire
Forbidden
Possible error codes: ERR_ACCESS_USER
Error code
Error message
Unprocessable Content
Possible error codes: ERR_INPUT_INVALID_EMAIL, ERR_INPUT_REQUIRED, ERR_INPUT_PASSWORD_COMPLEXITY_ERROR, ERR_INPUT_NOT_NUMERIC, ERR_INPUT_MIN_VALUE
Error code
Error message
Request blocked by WAF
curl -X POST \
"https://{instance}.kiteworks.com/rest/admin/users" \
-H "Authorization: Bearer YOUR_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"email": "string",
"name": "string",
"password": "string",
"userTypeId": 1,
"verified": true,
"sendNotification": true
}'import requests
url = "https://{instance}.kiteworks.com/rest/admin/users"
headers = {
"Authorization": "Bearer YOUR_TOKEN",
"Content-Type": "application/json",
}
payload = {
"email": "string",
"name": "string",
"password": "string",
"userTypeId": 1,
"verified": true,
"sendNotification": true
}
response = requests.post(url, headers=headers, json=payload)
print(response.json())Bulk update user emails
Bulk update user emails by migrating old email addresses to new ones. Accepts an array of objects containing old and new email pairs.
If set to true, returns information about the newly created entity.
Determines the detail level of the response body.
Array of user objects, each containing old and new email values.
Indicates whether to delete users whose emails match any in the newEmail field.
Email migration completed successfully. Returns the list of updated user objects.
The unique identifier of the user
The unique identifier of the user's root Kiteworks directory.
Date and time the user account was created
The user's email
The unique identifier of the user's mydir system directory.
The name of the user
The unique identifier of the user's 'My Folder'.
The unique identifier of the user type (profile).
Indicates whether the user is an internal user
URL to the user's profile icon image
Indicates whether the user is an External Distribution List
Key name of the custom metadata attribute associated with the user
Value assigned to the custom metadata attribute for the user
The ID of the admin role assigned to the user.
HATEOAS links associated with the entity
Indicates whether the user is an actual kitework user
Indicates whether the user is suspended
Indicates whether the user has been deleted
Authentication type.
- 0: No authentication,
- 1: Authentication by kiteworks,
- 2: Authentication by LDAP,
- 4: Authentication by SSO
Indicates whether the user is verified
Indicates whether the user has been deactivated
User's last activity datetime
The exact timestamp when the user's password will expire
Total number of items available.
Maximum number of items returned per page.
Number of items skipped before the current page.
Unprocessable Content
Possible error codes: ERR_INPUT_INVALID_EMAIL, ERR_INPUT_REQUIRED, ERR_INPUT_PASSWORD_COMPLEXITY_ERROR
Error code
Error message
Request blocked by WAF
curl -X POST \
"https://{instance}.kiteworks.com/rest/admin/users/migrateEmails" \
-H "Authorization: Bearer YOUR_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"users": [
{
"oldEmail": "string",
"newEmail": "string"
}
],
"deleteIfExists": true
}'import requests
url = "https://{instance}.kiteworks.com/rest/admin/users/migrateEmails"
headers = {
"Authorization": "Bearer YOUR_TOKEN",
"Content-Type": "application/json",
}
payload = {
"users": [
{
"oldEmail": "string",
"newEmail": "string"
}
],
"deleteIfExists": true
}
response = requests.post(url, headers=headers, json=payload)
print(response.json())Bulk update user emails via CSV file
Bulk update user emails by migrating old email addresses to new ones using a CSV file.
If set to true, returns information about the newly created entity.
Determines the detail level of the response body.
CSV file containing old and new email pairs.
Indicates whether to delete users whose emails match any in the newEmail field.
Email migration completed successfully. Returns the list of updated user objects.
The unique identifier of the user
The unique identifier of the user's root Kiteworks directory.
Date and time the user account was created
The user's email
The unique identifier of the user's mydir system directory.
The name of the user
The unique identifier of the user's 'My Folder'.
The unique identifier of the user type (profile).
Indicates whether the user is an internal user
URL to the user's profile icon image
Indicates whether the user is an External Distribution List
Key name of the custom metadata attribute associated with the user
Value assigned to the custom metadata attribute for the user
The ID of the admin role assigned to the user.
HATEOAS links associated with the entity
Indicates whether the user is an actual kitework user
Indicates whether the user is suspended
Indicates whether the user has been deleted
Authentication type.
- 0: No authentication,
- 1: Authentication by kiteworks,
- 2: Authentication by LDAP,
- 4: Authentication by SSO
Indicates whether the user is verified
Indicates whether the user has been deactivated
User's last activity datetime
The exact timestamp when the user's password will expire
Total number of items available.
Maximum number of items returned per page.
Number of items skipped before the current page.
Unprocessable Content
Possible error codes: ERR_INPUT_NOT_BOOLEAN
Error code
Error message
Request blocked by WAF
curl -X POST \
"https://{instance}.kiteworks.com/rest/admin/users/migrateEmailsCsv" \
-H "Authorization: Bearer YOUR_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"body": "string",
"deleteIfExists": true
}'import requests
url = "https://{instance}.kiteworks.com/rest/admin/users/migrateEmailsCsv"
headers = {
"Authorization": "Bearer YOUR_TOKEN",
"Content-Type": "application/json",
}
payload = {
"body": "string",
"deleteIfExists": true
}
response = requests.post(url, headers=headers, json=payload)
print(response.json())Get User
Returns the details of the specified user, including their name, email address, and account status.
ID of the user to retrieve
Returns the requested user's details.
The unique identifier of the user
The unique identifier of the user's root Kiteworks directory.
Date and time the user account was created
The user's email
The unique identifier of the user's mydir system directory.
The name of the user
The unique identifier of the user's 'My Folder'.
The unique identifier of the user type (profile).
Indicates whether the user is an internal user
URL to the user's profile icon image
Indicates whether the user is an External Distribution List
Key name of the custom metadata attribute associated with the user
Value assigned to the custom metadata attribute for the user
The ID of the admin role assigned to the user.
HATEOAS links associated with the entity
Indicates whether the user is an actual kitework user
Indicates whether the user is suspended
Indicates whether the user has been deleted
Authentication type.
- 0: No authentication,
- 1: Authentication by kiteworks,
- 2: Authentication by LDAP,
- 4: Authentication by SSO
Indicates whether the user is verified
Indicates whether the user has been deactivated
User's last activity datetime
The exact timestamp when the user's password will expire
Request blocked by WAF
curl -X GET \
"https://{instance}.kiteworks.com/rest/admin/users/:id" \
-H "Authorization: Bearer YOUR_TOKEN"import requests
id = "VALUE" # ID of the user to retrieve
url = f"https://{{instance}}.kiteworks.com/rest/admin/users/{id}"
headers = {
"Authorization": "Bearer YOUR_TOKEN",
}
response = requests.get(url, headers=headers)
print(response.json())Update User
Updates the details of a user, such as changing their name, setting them as deleted, or updating their active/inactive status.
ID of the user to be updated
Indicates whether the user is suspended. Set to true to suspend the user.
The name of the user
The user's password
Indicates whether the user is verified
Indicates whether the user is deactivated. Set to true to deactivate the user.
Indicates whether HATEOAS links should be included in the response
User updated successfully. Returns the updated user object.
The unique identifier of the user
The unique identifier of the user's root Kiteworks directory.
Date and time the user account was created
The user's email
The unique identifier of the user's mydir system directory.
The name of the user
The unique identifier of the user's 'My Folder'.
The unique identifier of the user type (profile).
Indicates whether the user is an internal user
URL to the user's profile icon image
Indicates whether the user is an External Distribution List
Key name of the custom metadata attribute associated with the user
Value assigned to the custom metadata attribute for the user
The ID of the admin role assigned to the user.
HATEOAS links associated with the entity
Indicates whether the user is an actual kitework user
Indicates whether the user is suspended
Indicates whether the user has been deleted
Authentication type.
- 0: No authentication,
- 1: Authentication by kiteworks,
- 2: Authentication by LDAP,
- 4: Authentication by SSO
Indicates whether the user is verified
Indicates whether the user has been deactivated
User's last activity datetime
The exact timestamp when the user's password will expire
Forbidden
Possible error codes: ERR_ACCESS_USER
Error code
Error message
Request blocked by WAF
curl -X PUT \
"https://{instance}.kiteworks.com/rest/admin/users/:id" \
-H "Authorization: Bearer YOUR_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"suspended": true,
"name": "string",
"password": "string",
"verified": true,
"deactivated": true,
"addLinks": true
}'import requests
id = "VALUE" # ID of the user to be updated
url = f"https://{{instance}}.kiteworks.com/rest/admin/users/{id}"
headers = {
"Authorization": "Bearer YOUR_TOKEN",
"Content-Type": "application/json",
}
payload = {
"suspended": true,
"name": "string",
"password": "string",
"verified": true,
"deactivated": true,
"addLinks": true
}
response = requests.put(url, headers=headers, json=payload)
print(response.json())Deletes a User
Mark the specified user as deleted. This user will still be returned in the GET Users query.
ID of the user to delete
The ID of the new owner to whom the data will be transferred, applicable when retainData and/or retainPermissionToSharedData are set to true.
The ID of the user to whom the advanced form data will be transferred, similar to retainToUser but specifically for advanced form components.
Indicates whether to remotely wipe data from both desktop and mobile devices.
Indicates whether data owned by the user should be deleted. This is required and must be set to True if retainData is False, and vice versa.
Indicates whether data should be retained and transferred to another user. This is required and must be True if deleteUnsharedData is False, and vice versa.
Indicates whether permissions to shared folders should be retained.
Indicates whether files sent by deleted or demoted users should be withdrawn.
Indicates whether request files sent by deleted or demoted users should be withdrawn.
If set to true, the operation will continue for the valid items even if some items result in failure.
Determines the detail level of the response body.
User marked as deleted successfully.
Forbidden
Possible error codes: ERR_ACCESS_USER
Error code
Error message
Unprocessable Content
Possible error codes: ERR_INPUT_NOT_BOOLEAN, ERR_INPUT_ATTRIBUTE_FORBIDDEN, ERR_INPUT_REQUIRED, ERR_INPUT_NOT_STRING
Error code
Error message
Request blocked by WAF
curl -X DELETE \
"https://{instance}.kiteworks.com/rest/admin/users/:id" \
-H "Authorization: Bearer YOUR_TOKEN"import requests
id = "VALUE" # ID of the user to delete
url = f"https://{{instance}}.kiteworks.com/rest/admin/users/{id}"
headers = {
"Authorization": "Bearer YOUR_TOKEN",
}
response = requests.delete(url, headers=headers)
print(response.json())Return admin roles of the specified user id.
Returns all admin roles assigned to the specified user. The user may be active or deleted.
ID of the user to retrieve admin role
Sorting options
With parameters
Determines the detail level of the response body.
Returns the list of admin roles assigned to the specified user.
Admin role unique identifier
Display name of the admin role
Admin role globally unique identifier
HATEOAS links associated with the entity
Forbidden
Possible error codes: ERR_ACCESS_USER
Error code
Error message
Request blocked by WAF
curl -X GET \
"https://{instance}.kiteworks.com/rest/admin/users/:id/adminRoles" \
-H "Authorization: Bearer YOUR_TOKEN"import requests
id = "VALUE" # ID of the user to retrieve admin role
url = f"https://{{instance}}.kiteworks.com/rest/admin/users/{id}/adminRoles"
headers = {
"Authorization": "Bearer YOUR_TOKEN",
}
response = requests.get(url, headers=headers)
print(response.json())List devices for a user
Returns a list of devices registered to the specified user.
ID of the user whose devices to be retrieved
Unique identifier of install tag for this Device
Unique identifier of install tag for this Device. Search for results that contain the specified characters in this parameter.
Unique identifier of user for this Device
Unique identifier of user for this Device. Search for results that match any of the specified values for this parameter.
Unique identifier of client for this Device
Unique identifier of client for this Device. Search for results that contain the specified characters in this parameter.
Sorting options
Offset
Limit
With parameters
Determines the detail level of the response body.
Returns a paginated list of device records for the specified user.
Unique identifier of Device
Unique identifier of client for this Device
Unique identifier of user for this Device
Unique identifier of the install tag for this device. Usually the serial number of the device
Install Tag name for this Device. e.g. Someone's IPhone
Flag that tells the device to remote wipe itself.
- 0 = not set, 1 = set, 2 = device has been notified, 3 = wipe is completed
Key to encrypt files on this device
HATEOAS links associated with the entity
Total number of items available.
Maximum number of items returned per page.
Number of items skipped before the current page.
Request blocked by WAF
curl -X GET \
"https://{instance}.kiteworks.com/rest/admin/users/:id/devices" \
-H "Authorization: Bearer YOUR_TOKEN"import requests
id = "VALUE" # ID of the user whose devices to be retrieved
url = f"https://{{instance}}.kiteworks.com/rest/admin/users/{id}/devices"
headers = {
"Authorization": "Bearer YOUR_TOKEN",
}
response = requests.get(url, headers=headers)
print(response.json())Get admin activities list
Description:
Retrieves the list of admin activities.Precondition:
The user must be an administrator with access to `Activity Log`.Response:
Returns the list of activities performed by the admin.Sorting:
Sort string syntax `FIELD_NAME:ORDER`.ORDER can be asc or desc.
Sorting options:
| FIELD_NAME | Description |
|---|---|
| created | The creation date and time of the activity |
| client | The client name |
| username | The username associated with the activity |
| ip_address | The client IP address |
The start date and time for the activity range.
The end date and time for the activity range.
Comma-separated list of event filters to filter the activities.
Comma-separated list of object IDs to filter the activities.
User ID to filter activities by a specific user.
Maximum number of pages to retrieve.
Sort order for the results. Default is created:desc.
Allowed values: created:asc, created:desc, client:asc, client:desc, username:asc, username:desc, ip_address:asc, ip_address:desc.
If true, returns a more compact response.
Maximum number of items to return.
Number of items to skip before returning results, for pagination.
The admin activities list is successfully returned.
Unique identifier of the activity event.
Date and time when the activity event was recorded.
Name of the activity event.
Human-readable summary of the activity event.
Type category of the activity event.
Indicates whether the activity completed successfully.
Full name of the user.
Email address associated with the user.
URL or identifier for the user's profile icon.
List of permissions required for the activity.
Additional event-specific data associated with the activity.
Unauthorized
Possible error codes: ERR_ACCESS_USER, ERR_AUTH_INVALID_CSRF, ERR_AUTH_UNAUTHORIZED
Error code
Error message
Unprocessable Content
Possible error codes: ERR_INVALID_PARAMETER
Error code
Error message
Request blocked by WAF
curl -X GET \
"https://{instance}.kiteworks.com/rest/admin/activities?startDateTime=VALUE&endDateTime=VALUE" \
-H "Authorization: Bearer YOUR_TOKEN"import requests
url = "https://{instance}.kiteworks.com/rest/admin/activities"
headers = {
"Authorization": "Bearer YOUR_TOKEN",
}
params = {
"startDateTime": "VALUE",
"endDateTime": "VALUE",
}
response = requests.get(url, params=params, headers=headers)
print(response.json())Get admin activity detail
Description:
Retrieves detailed information about a specific activity.Precondition:
The user must be an administrator with access to `Activity Log`.Response:
Returns the full details of the specified activity.The unique identifier (UUID) of the entity.
Successfully retrieved the activity details.
Unique identifier of the activity event.
Date and time when the activity event was recorded.
Name of the activity event.
Human-readable summary of the activity event.
Type category of the activity event.
Indicates whether the activity completed successfully.
Full name of the user.
Email address associated with the user.
URL or identifier for the user's profile icon.
List of permissions required for the activity.
Additional event-specific data associated with the activity.
Unauthorized
Possible error codes: ERR_ACCESS_USER, ERR_AUTH_INVALID_CSRF, ERR_AUTH_UNAUTHORIZED
Error code
Error message
Unprocessable Content
Possible error codes: ERR_INVALID_PARAMETER
Error code
Error message
Request blocked by WAF
curl -X GET \
"https://{instance}.kiteworks.com/rest/admin/activities/:id" \
-H "Authorization: Bearer YOUR_TOKEN"import requests
id = "VALUE" # The unique identifier (UUID) of the entity.
url = f"https://{{instance}}.kiteworks.com/rest/admin/activities/{id}"
headers = {
"Authorization": "Bearer YOUR_TOKEN",
}
response = requests.get(url, headers=headers)
print(response.json())Export admin activities list
Description:
Exports the list of admin activities based on the provided filters.Precondition:
The user must be an administrator with access to `Activity Log`.Response:
The admin activities list is generated and sent via email to the requesting user.Sorting:
Sort string syntax `FIELD_NAME:ORDER`.ORDER can be asc or desc.
Sorting options:
| FIELD_NAME | Description |
|---|---|
| created | The creation date and time of the activity |
| client | The client name |
| username | The username associated with the activity |
| ip_address | The client IP address |
The start date and time for the activity range.
The end date and time for the activity range.
Comma-separated list of event filters to filter the activities.
Comma-separated list of object IDs to filter the activities.
User ID to filter activities by a specific user.
Maximum number of pages to retrieve.
Sort order for the results. Default is created:desc.
Allowed values: created:asc, created:desc, client:asc, client:desc, username:asc, username:desc, ip_address:asc, ip_address:desc.
If true, returns a more compact response.
Maximum number of items to return.
Number of items to skip before returning results, for pagination.
The admin activities list is being processed and will be sent via email.
Unauthorized
Possible error codes: ERR_ACCESS_USER, ERR_AUTH_INVALID_CSRF, ERR_AUTH_UNAUTHORIZED
Error code
Error message
Unprocessable Content
Possible error codes: ERR_INVALID_PARAMETER
Error code
Error message
Request blocked by WAF
curl -X GET \
"https://{instance}.kiteworks.com/rest/admin/activities/actions/exportCSV?startDateTime=VALUE&endDateTime=VALUE" \
-H "Authorization: Bearer YOUR_TOKEN"import requests
url = "https://{instance}.kiteworks.com/rest/admin/activities/actions/exportCSV"
headers = {
"Authorization": "Bearer YOUR_TOKEN",
}
params = {
"startDateTime": "VALUE",
"endDateTime": "VALUE",
}
response = requests.get(url, params=params, headers=headers)
print(response.json())