Add custom profile
Creates a new custom user type profile cloned from an existing built-in profile (e.g., Standard). The new profile's name must be unique. Returns 404 if the specified prototype profile does not exist.
If set to true, returns information about the newly created entity.
Determines the detail level of the response body.
Display name of the profile
Id of the prototype profile to be cloned. If not passed, the Standard profile will be used
Custom profile created 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
Forbidden
Possible error codes: ERR_ACCESS_USER
Error code
Error message
Conflict
Possible error codes: ERR_ENTITY_EXISTS
Error code
Error message
Unprocessable Content
Possible error codes: ERR_INPUT_NOT_IN_RANGE, ERR_INPUT_NOT_ALPHA_DASH, ERR_INPUT_REQUIRED
Error code
Error message
Request blocked by WAF
curl -X POST \
"https://{instance}.kiteworks.com/rest/profiles" \
-H "Authorization: Bearer YOUR_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"name": "string",
"prototype": 1
}'import requests
url = "https://{instance}.kiteworks.com/rest/profiles"
headers = {
"Authorization": "Bearer YOUR_TOKEN",
"Content-Type": "application/json",
}
payload = {
"name": "string",
"prototype": 1
}
response = requests.post(url, headers=headers, json=payload)
print(response.json())Return user type (profile) details
Returns the details of the current user's own type profile, including its name, built-in status, and cloneability. Returns 403 if the requested profile does not belong to the current user.
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/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/profiles/{id}"
headers = {
"Authorization": "Bearer YOUR_TOKEN",
}
response = requests.get(url, headers=headers)
print(response.json())Update profile
Updates the feature settings of the specified user type profile. When disabling collaboration access, optional demotion settings control how existing user data is handled (retained, deleted, or transferred to another user).
ID of the profile to be modified
Indicates whether SFTP access is allowed
Max storage in bytes
Maximum storage space that user is entitled to
Allow to modify file secure link expiration
Allow sending files to external users
Link expiration date in days
LDAP Mapping value to determine the user profile type
Allow to create top level folders
Allow to create system quota folders
Set the maximum quota for a system folder
Set the maximum number of system folders
Set the default quota for a system folder
Upper limit allowed for secure link expiration
Who can download file via the secure link
Who can download file via the secure link
Set excluded file extensions
Set excluded file groups
Set custom file types
Indicates whether Collaboration and Shared Folders are allowed
Upper limit allowed for number of attachments per mail.
Disallow Collaboration: Wipe remote devices
Disallow Collaboration: Delete all data owned by the user
Disallow Collaboration: retain the data owned by the user
Disallow Collaboration: re-assign the data to the following user
Disallow Collaboration: retain all permission to shared data
Profile updated 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
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, ERR_INPUT_NOT_INTEGER, ERR_INPUT_MIN_VALUE, ERR_INPUT_NOT_IN_LIST, ERR_INPUT_MAX_VALUE, ERR_INPUT_NOT_LESS_THEN, ERR_INPUT_NOT_ALLOWED, ERR_INPUT_INVALID, ERR_INPUT_NOT_ARRAY
Error code
Error message
Request blocked by WAF
curl -X PUT \
"https://{instance}.kiteworks.com/rest/profiles/:id" \
-H "Authorization: Bearer YOUR_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"allowSftp": true,
"maxStorage": 1,
"storageQuota": 1,
"setExpirationLower": true,
"sendExternal": 1,
"linkExpiration": 1
}'import requests
id = "VALUE" # ID of the profile to be modified
url = f"https://{{instance}}.kiteworks.com/rest/profiles/{id}"
headers = {
"Authorization": "Bearer YOUR_TOKEN",
"Content-Type": "application/json",
}
payload = {
"allowSftp": true,
"maxStorage": 1,
"storageQuota": 1,
"setExpirationLower": true,
"sendExternal": 1,
"linkExpiration": 1
}
response = requests.put(url, headers=headers, json=payload)
print(response.json())Delete custom profile and set new profile instead of deleted profile
Permanently deletes the specified custom profile and reassigns all affected users to the specified replacement profile. Optional demotion settings control how existing user data is handled during the transition.
ID of the custom profile to be deleted
ID of the replacement profile to assign to affected users
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.
Custom profile 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/profiles/:id/replace/:new_profile" \
-H "Authorization: Bearer YOUR_TOKEN"import requests
id = "VALUE" # ID of the custom profile to be deleted
new_profile = "VALUE" # ID of the replacement profile to assign to affected users
url = f"https://{{instance}}.kiteworks.com/rest/profiles/{id}/replace/{new_profile}"
headers = {
"Authorization": "Bearer YOUR_TOKEN",
}
response = requests.delete(url, headers=headers)
print(response.json())