Retrieve users
Description:
Returns a paginated list of SCIM users matching the specified filter criteria.Precondition:
The request must be authenticated using a valid SCIM token.Response:
A list of SCIM users is returned.Comma-separated list of attribute names to include in the response.
Comma-separated list of attribute names to exclude from the response.
SCIM filter expression to narrow the list of returned users (e.g., userName eq "user@example.com").
Attribute name to sort results by.
Sort direction for the results.ascending – Sort in ascending order.descending – Sort in descending order.
1-based index of the first result to return, used for pagination.
Maximum number of results to return per page (maximum: 1,000,000).
The users are returned successfully.
List of SCIM schema URIs applicable to this response.
Total number of matching SCIM users.
Number of users returned per page.
1-based index of the first result in the current page.
List of SCIM schema URIs applicable to this resource.
Unique identifier of the SCIM user (maps to the user GUID).
SCIM resource type (e.g., User).
Date and time when the SCIM resource was created.
Date and time when the SCIM resource was last modified.
URI of the SCIM resource.
Username of the SCIM user (maps to email address).
Display name of the SCIM user.
User type based on the assigned profile name.
Preferred language of the user.
Indicates whether the user account is active.
Value of the multi-value attribute (e.g., email address or phone number).
Type label for the value (e.g., work, home).
Indicates whether this is the primary value for the attribute.
Value of the multi-value attribute (e.g., email address or phone number).
Type label for the value (e.g., work, home).
Indicates whether this is the primary value for the attribute.
Value of the multi-value attribute (e.g., email address or phone number).
Type label for the value (e.g., work, home).
Indicates whether this is the primary value for the attribute.
Value of the multi-value attribute (e.g., email address or phone number).
Type label for the value (e.g., work, home).
Indicates whether this is the primary value for the attribute.
Bad request.
Unauthorized.
Forbidden.
Request blocked by WAF
curl -X GET \
"https://{instance}.kiteworks.com/rest/scim/users" \
-H "Authorization: Bearer YOUR_TOKEN"import requests
url = "https://{instance}.kiteworks.com/rest/scim/users"
headers = {
"Authorization": "Bearer YOUR_TOKEN",
}
response = requests.get(url, headers=headers)
print(response.json())Create a user
Description:
Creates a new SCIM user with the specified attributes.Precondition:
The request must be authenticated using a valid SCIM token.Response:
The newly created user is returned.Comma-separated list of attribute names to include in the response.
Comma-separated list of attribute names to exclude from the response.
List of SCIM schema URNs applicable to this resource. Must include urn:ietf:params:scim:schemas:core:2.0:User.
The user's password.
The user's display name. Must not contain < or > characters.
The user's type identifier (alphanumeric characters, underscores, and hyphens only).
List of phone numbers associated with the user.
List of roles assigned to the user. At most one role may be specified.
The user's email address, used as the unique username.
If true, sends a notification email to the user upon account creation.
If true, requires the user to change their password on first login.
The user is created successfully.
List of SCIM schema URIs applicable to this resource.
Unique identifier of the SCIM user (maps to the user GUID).
SCIM resource type (e.g., User).
Date and time when the SCIM resource was created.
Date and time when the SCIM resource was last modified.
URI of the SCIM resource.
Username of the SCIM user (maps to email address).
Display name of the SCIM user.
User type based on the assigned profile name.
Preferred language of the user.
Indicates whether the user account is active.
Value of the multi-value attribute (e.g., email address or phone number).
Type label for the value (e.g., work, home).
Indicates whether this is the primary value for the attribute.
Value of the multi-value attribute (e.g., email address or phone number).
Type label for the value (e.g., work, home).
Indicates whether this is the primary value for the attribute.
Value of the multi-value attribute (e.g., email address or phone number).
Type label for the value (e.g., work, home).
Indicates whether this is the primary value for the attribute.
Value of the multi-value attribute (e.g., email address or phone number).
Type label for the value (e.g., work, home).
Indicates whether this is the primary value for the attribute.
Bad request.
Unauthorized.
Forbidden.
Conflict.
Request blocked by WAF
curl -X POST \
"https://{instance}.kiteworks.com/rest/scim/users" \
-H "Authorization: Bearer YOUR_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"schemas": [
"string"
],
"password": "string",
"displayName": "string",
"userType": "string",
"phoneNumbers": [
{
"primary": true,
"value": "string",
"type": "string"
}
],
"roles": [
{
"value": "string"
}
]
}'import requests
url = "https://{instance}.kiteworks.com/rest/scim/users"
headers = {
"Authorization": "Bearer YOUR_TOKEN",
"Content-Type": "application/json",
}
payload = {
"schemas": [
"string"
],
"password": "string",
"displayName": "string",
"userType": "string",
"phoneNumbers": [
{
"primary": true,
"value": "string",
"type": "string"
}
],
"roles": [
{
"value": "string"
}
]
}
response = requests.post(url, headers=headers, json=payload)
print(response.json())Retrieve users
Description:
Returns a paginated list of SCIM users matching the specified filter criteria.Precondition:
The request must be authenticated using a valid SCIM token.Response:
A list of SCIM users is returned.Comma-separated list of attribute names to include in the response.
Comma-separated list of attribute names to exclude from the response.
SCIM filter expression to narrow the list of returned users (e.g., userName eq "user@example.com").
Attribute name to sort results by.
Sort direction for the results.ascending – Sort in ascending order.descending – Sort in descending order.
1-based index of the first result to return, used for pagination.
Maximum number of results to return per page (maximum: 1,000,000).
The users are returned successfully.
List of SCIM schema URIs applicable to this response.
Total number of matching SCIM users.
Number of users returned per page.
1-based index of the first result in the current page.
List of SCIM schema URIs applicable to this resource.
Unique identifier of the SCIM user (maps to the user GUID).
SCIM resource type (e.g., User).
Date and time when the SCIM resource was created.
Date and time when the SCIM resource was last modified.
URI of the SCIM resource.
Username of the SCIM user (maps to email address).
Display name of the SCIM user.
User type based on the assigned profile name.
Preferred language of the user.
Indicates whether the user account is active.
Value of the multi-value attribute (e.g., email address or phone number).
Type label for the value (e.g., work, home).
Indicates whether this is the primary value for the attribute.
Value of the multi-value attribute (e.g., email address or phone number).
Type label for the value (e.g., work, home).
Indicates whether this is the primary value for the attribute.
Value of the multi-value attribute (e.g., email address or phone number).
Type label for the value (e.g., work, home).
Indicates whether this is the primary value for the attribute.
Value of the multi-value attribute (e.g., email address or phone number).
Type label for the value (e.g., work, home).
Indicates whether this is the primary value for the attribute.
Bad request.
Unauthorized.
Forbidden.
Request blocked by WAF
curl -X GET \
"https://{instance}.kiteworks.com/rest/scim/Users" \
-H "Authorization: Bearer YOUR_TOKEN"import requests
url = "https://{instance}.kiteworks.com/rest/scim/Users"
headers = {
"Authorization": "Bearer YOUR_TOKEN",
}
response = requests.get(url, headers=headers)
print(response.json())Create a user
Description:
Creates a new SCIM user with the specified attributes.Precondition:
The request must be authenticated using a valid SCIM token.Response:
The newly created user is returned.Comma-separated list of attribute names to include in the response.
Comma-separated list of attribute names to exclude from the response.
List of SCIM schema URNs applicable to this resource. Must include urn:ietf:params:scim:schemas:core:2.0:User.
The user's password.
The user's display name. Must not contain < or > characters.
The user's type identifier (alphanumeric characters, underscores, and hyphens only).
List of phone numbers associated with the user.
List of roles assigned to the user. At most one role may be specified.
The user's email address, used as the unique username.
If true, sends a notification email to the user upon account creation.
If true, requires the user to change their password on first login.
The user is created successfully.
List of SCIM schema URIs applicable to this resource.
Unique identifier of the SCIM user (maps to the user GUID).
SCIM resource type (e.g., User).
Date and time when the SCIM resource was created.
Date and time when the SCIM resource was last modified.
URI of the SCIM resource.
Username of the SCIM user (maps to email address).
Display name of the SCIM user.
User type based on the assigned profile name.
Preferred language of the user.
Indicates whether the user account is active.
Value of the multi-value attribute (e.g., email address or phone number).
Type label for the value (e.g., work, home).
Indicates whether this is the primary value for the attribute.
Value of the multi-value attribute (e.g., email address or phone number).
Type label for the value (e.g., work, home).
Indicates whether this is the primary value for the attribute.
Value of the multi-value attribute (e.g., email address or phone number).
Type label for the value (e.g., work, home).
Indicates whether this is the primary value for the attribute.
Value of the multi-value attribute (e.g., email address or phone number).
Type label for the value (e.g., work, home).
Indicates whether this is the primary value for the attribute.
Bad request.
Unauthorized.
Forbidden.
Conflict.
Request blocked by WAF
curl -X POST \
"https://{instance}.kiteworks.com/rest/scim/Users" \
-H "Authorization: Bearer YOUR_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"schemas": [
"string"
],
"password": "string",
"displayName": "string",
"userType": "string",
"phoneNumbers": [
{
"primary": true,
"value": "string",
"type": "string"
}
],
"roles": [
{
"value": "string"
}
]
}'import requests
url = "https://{instance}.kiteworks.com/rest/scim/Users"
headers = {
"Authorization": "Bearer YOUR_TOKEN",
"Content-Type": "application/json",
}
payload = {
"schemas": [
"string"
],
"password": "string",
"displayName": "string",
"userType": "string",
"phoneNumbers": [
{
"primary": true,
"value": "string",
"type": "string"
}
],
"roles": [
{
"value": "string"
}
]
}
response = requests.post(url, headers=headers, json=payload)
print(response.json())Return a user
Description:
Returns the SCIM user corresponding to the provided ID.Precondition:
The request must be authenticated using a valid SCIM token.Response:
The user is returned.The unique identifier (UUID) of the entity.
Comma-separated list of attribute names to include in the response.
Comma-separated list of attribute names to exclude from the response.
The user is returned successfully.
List of SCIM schema URIs applicable to this resource.
Unique identifier of the SCIM user (maps to the user GUID).
SCIM resource type (e.g., User).
Date and time when the SCIM resource was created.
Date and time when the SCIM resource was last modified.
URI of the SCIM resource.
Username of the SCIM user (maps to email address).
Display name of the SCIM user.
User type based on the assigned profile name.
Preferred language of the user.
Indicates whether the user account is active.
Value of the multi-value attribute (e.g., email address or phone number).
Type label for the value (e.g., work, home).
Indicates whether this is the primary value for the attribute.
Value of the multi-value attribute (e.g., email address or phone number).
Type label for the value (e.g., work, home).
Indicates whether this is the primary value for the attribute.
Value of the multi-value attribute (e.g., email address or phone number).
Type label for the value (e.g., work, home).
Indicates whether this is the primary value for the attribute.
Value of the multi-value attribute (e.g., email address or phone number).
Type label for the value (e.g., work, home).
Indicates whether this is the primary value for the attribute.
Bad request.
Unauthorized.
Forbidden.
Request blocked by WAF
curl -X GET \
"https://{instance}.kiteworks.com/rest/scim/users/:id" \
-H "Authorization: Bearer YOUR_TOKEN"import requests
id = "VALUE" # The unique identifier (UUID) of the entity.
url = f"https://{{instance}}.kiteworks.com/rest/scim/users/{id}"
headers = {
"Authorization": "Bearer YOUR_TOKEN",
}
response = requests.get(url, headers=headers)
print(response.json())Update a user
Description:
Updates the SCIM user corresponding to the provided ID.Precondition:
The request must be authenticated using a valid SCIM token.Response:
The updated user is returned.The unique identifier (UUID) of the entity.
List of SCIM schema URNs applicable to this resource. Must include urn:ietf:params:scim:schemas:core:2.0:User.
The user's password.
The user's display name. Must not contain < or > characters.
The user's type identifier (alphanumeric characters, underscores, and hyphens only).
List of phone numbers associated with the user.
List of roles assigned to the user. At most one role may be specified.
If true, activates the user account; if false, deactivates it.
Data retention options to apply when the user type is demoted.
The user is updated and returned successfully.
List of SCIM schema URIs applicable to this resource.
Unique identifier of the SCIM user (maps to the user GUID).
SCIM resource type (e.g., User).
Date and time when the SCIM resource was created.
Date and time when the SCIM resource was last modified.
URI of the SCIM resource.
Username of the SCIM user (maps to email address).
Display name of the SCIM user.
User type based on the assigned profile name.
Preferred language of the user.
Indicates whether the user account is active.
Value of the multi-value attribute (e.g., email address or phone number).
Type label for the value (e.g., work, home).
Indicates whether this is the primary value for the attribute.
Value of the multi-value attribute (e.g., email address or phone number).
Type label for the value (e.g., work, home).
Indicates whether this is the primary value for the attribute.
Value of the multi-value attribute (e.g., email address or phone number).
Type label for the value (e.g., work, home).
Indicates whether this is the primary value for the attribute.
Value of the multi-value attribute (e.g., email address or phone number).
Type label for the value (e.g., work, home).
Indicates whether this is the primary value for the attribute.
ERR_AUTH_INVALID_CSRF
ERR_AUTH_UNAUTHORIZED
ERR_ENTITY_NOT_FOUND
Request blocked by WAF
curl -X PUT \
"https://{instance}.kiteworks.com/rest/scim/users/:id" \
-H "Authorization: Bearer YOUR_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"schemas": [
"string"
],
"password": "string",
"displayName": "string",
"userType": "string",
"phoneNumbers": [
{
"primary": true,
"value": "string",
"type": "string"
}
],
"roles": [
{
"value": "string"
}
]
}'import requests
id = "VALUE" # The unique identifier (UUID) of the entity.
url = f"https://{{instance}}.kiteworks.com/rest/scim/users/{id}"
headers = {
"Authorization": "Bearer YOUR_TOKEN",
"Content-Type": "application/json",
}
payload = {
"schemas": [
"string"
],
"password": "string",
"displayName": "string",
"userType": "string",
"phoneNumbers": [
{
"primary": true,
"value": "string",
"type": "string"
}
],
"roles": [
{
"value": "string"
}
]
}
response = requests.put(url, headers=headers, json=payload)
print(response.json())Delete a user
Description:
Deletes the SCIM user corresponding to the provided ID.Precondition:
The request must be authenticated using a valid SCIM token.Response:
The user is deleted.The unique identifier (UUID) of the entity.
If true, triggers a remote wipe of the user data from all registered devices.
If true, permanently deletes data that is not shared with other users.
If true, retains the user data after deletion.
If true, the specified retainToUser will retain access to shared data.
UUID of the user who will receive ownership of the deleted user data.
The user is deleted successfully.
Bad request.
Unauthorized.
Forbidden.
Request blocked by WAF
curl -X DELETE \
"https://{instance}.kiteworks.com/rest/scim/users/:id" \
-H "Authorization: Bearer YOUR_TOKEN"import requests
id = "VALUE" # The unique identifier (UUID) of the entity.
url = f"https://{{instance}}.kiteworks.com/rest/scim/users/{id}"
headers = {
"Authorization": "Bearer YOUR_TOKEN",
}
response = requests.delete(url, headers=headers)
print(response.json())Return a user
Description:
Returns the SCIM user corresponding to the provided ID.Precondition:
The request must be authenticated using a valid SCIM token.Response:
The user is returned.The unique identifier (UUID) of the entity.
Comma-separated list of attribute names to include in the response.
Comma-separated list of attribute names to exclude from the response.
The user is returned successfully.
List of SCIM schema URIs applicable to this resource.
Unique identifier of the SCIM user (maps to the user GUID).
SCIM resource type (e.g., User).
Date and time when the SCIM resource was created.
Date and time when the SCIM resource was last modified.
URI of the SCIM resource.
Username of the SCIM user (maps to email address).
Display name of the SCIM user.
User type based on the assigned profile name.
Preferred language of the user.
Indicates whether the user account is active.
Value of the multi-value attribute (e.g., email address or phone number).
Type label for the value (e.g., work, home).
Indicates whether this is the primary value for the attribute.
Value of the multi-value attribute (e.g., email address or phone number).
Type label for the value (e.g., work, home).
Indicates whether this is the primary value for the attribute.
Value of the multi-value attribute (e.g., email address or phone number).
Type label for the value (e.g., work, home).
Indicates whether this is the primary value for the attribute.
Value of the multi-value attribute (e.g., email address or phone number).
Type label for the value (e.g., work, home).
Indicates whether this is the primary value for the attribute.
Bad request.
Unauthorized.
Forbidden.
Request blocked by WAF
curl -X GET \
"https://{instance}.kiteworks.com/rest/scim/Users/:id" \
-H "Authorization: Bearer YOUR_TOKEN"import requests
id = "VALUE" # The unique identifier (UUID) of the entity.
url = f"https://{{instance}}.kiteworks.com/rest/scim/Users/{id}"
headers = {
"Authorization": "Bearer YOUR_TOKEN",
}
response = requests.get(url, headers=headers)
print(response.json())Update a user
Description:
Updates the SCIM user corresponding to the provided ID.Precondition:
The request must be authenticated using a valid SCIM token.Response:
The updated user is returned.The unique identifier (UUID) of the entity.
List of SCIM schema URNs applicable to this resource. Must include urn:ietf:params:scim:schemas:core:2.0:User.
The user's password.
The user's display name. Must not contain < or > characters.
The user's type identifier (alphanumeric characters, underscores, and hyphens only).
List of phone numbers associated with the user.
List of roles assigned to the user. At most one role may be specified.
If true, activates the user account; if false, deactivates it.
Data retention options to apply when the user type is demoted.
The user is updated and returned successfully.
List of SCIM schema URIs applicable to this resource.
Unique identifier of the SCIM user (maps to the user GUID).
SCIM resource type (e.g., User).
Date and time when the SCIM resource was created.
Date and time when the SCIM resource was last modified.
URI of the SCIM resource.
Username of the SCIM user (maps to email address).
Display name of the SCIM user.
User type based on the assigned profile name.
Preferred language of the user.
Indicates whether the user account is active.
Value of the multi-value attribute (e.g., email address or phone number).
Type label for the value (e.g., work, home).
Indicates whether this is the primary value for the attribute.
Value of the multi-value attribute (e.g., email address or phone number).
Type label for the value (e.g., work, home).
Indicates whether this is the primary value for the attribute.
Value of the multi-value attribute (e.g., email address or phone number).
Type label for the value (e.g., work, home).
Indicates whether this is the primary value for the attribute.
Value of the multi-value attribute (e.g., email address or phone number).
Type label for the value (e.g., work, home).
Indicates whether this is the primary value for the attribute.
ERR_AUTH_INVALID_CSRF
ERR_AUTH_UNAUTHORIZED
ERR_ENTITY_NOT_FOUND
Request blocked by WAF
curl -X PUT \
"https://{instance}.kiteworks.com/rest/scim/Users/:id" \
-H "Authorization: Bearer YOUR_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"schemas": [
"string"
],
"password": "string",
"displayName": "string",
"userType": "string",
"phoneNumbers": [
{
"primary": true,
"value": "string",
"type": "string"
}
],
"roles": [
{
"value": "string"
}
]
}'import requests
id = "VALUE" # The unique identifier (UUID) of the entity.
url = f"https://{{instance}}.kiteworks.com/rest/scim/Users/{id}"
headers = {
"Authorization": "Bearer YOUR_TOKEN",
"Content-Type": "application/json",
}
payload = {
"schemas": [
"string"
],
"password": "string",
"displayName": "string",
"userType": "string",
"phoneNumbers": [
{
"primary": true,
"value": "string",
"type": "string"
}
],
"roles": [
{
"value": "string"
}
]
}
response = requests.put(url, headers=headers, json=payload)
print(response.json())Delete a user
Description:
Deletes the SCIM user corresponding to the provided ID.Precondition:
The request must be authenticated using a valid SCIM token.Response:
The user is deleted.The unique identifier (UUID) of the entity.
If true, triggers a remote wipe of the user data from all registered devices.
If true, permanently deletes data that is not shared with other users.
If true, retains the user data after deletion.
If true, the specified retainToUser will retain access to shared data.
UUID of the user who will receive ownership of the deleted user data.
The user is deleted successfully.
Bad request.
Unauthorized.
Forbidden.
Request blocked by WAF
curl -X DELETE \
"https://{instance}.kiteworks.com/rest/scim/Users/:id" \
-H "Authorization: Bearer YOUR_TOKEN"import requests
id = "VALUE" # The unique identifier (UUID) of the entity.
url = f"https://{{instance}}.kiteworks.com/rest/scim/Users/{id}"
headers = {
"Authorization": "Bearer YOUR_TOKEN",
}
response = requests.delete(url, headers=headers)
print(response.json())Return SCIM service provider configuration
Description:
Returns the SCIM service provider configuration, including supported features and authentication schemes.Precondition:
The request must be authenticated using a valid SCIM token.Response:
The service provider configuration is returned.The service provider configuration is returned successfully.
Unauthorized.
Forbidden.
Request blocked by WAF
curl -X GET \
"https://{instance}.kiteworks.com/rest/scim/ServiceProviderConfig" \
-H "Authorization: Bearer YOUR_TOKEN"import requests
url = "https://{instance}.kiteworks.com/rest/scim/ServiceProviderConfig"
headers = {
"Authorization": "Bearer YOUR_TOKEN",
}
response = requests.get(url, headers=headers)
print(response.json())Return SCIM schemas
Description:
Returns all supported SCIM schemas.Precondition:
The request must be authenticated using a valid SCIM token.Response:
The supported SCIM schemas are returned.The supported SCIM schemas are returned successfully.
Unauthorized.
Forbidden.
Request blocked by WAF
curl -X GET \
"https://{instance}.kiteworks.com/rest/scim/Schemas" \
-H "Authorization: Bearer YOUR_TOKEN"import requests
url = "https://{instance}.kiteworks.com/rest/scim/Schemas"
headers = {
"Authorization": "Bearer YOUR_TOKEN",
}
response = requests.get(url, headers=headers)
print(response.json())Return a SCIM schema
Description:
Returns the SCIM schema corresponding to the provided ID.Precondition:
The request must be authenticated using a valid SCIM token.Response:
The requested SCIM schema is returned if it exists.The ID/URN of the schema
The requested SCIM schema is returned successfully.
Unauthorized.
Forbidden.
Request blocked by WAF
curl -X GET \
"https://{instance}.kiteworks.com/rest/scim/Schemas/:id" \
-H "Authorization: Bearer YOUR_TOKEN"import requests
id = "VALUE" # The ID/URN of the schema
url = f"https://{{instance}}.kiteworks.com/rest/scim/Schemas/{id}"
headers = {
"Authorization": "Bearer YOUR_TOKEN",
}
response = requests.get(url, headers=headers)
print(response.json())Return SCIM resource types
Description:
Returns all supported SCIM resource types.Precondition:
The request must be authenticated using a valid SCIM token.Response:
The supported SCIM resource types are returned.The supported SCIM resource types are returned successfully.
Unauthorized.
Forbidden.
Request blocked by WAF
curl -X GET \
"https://{instance}.kiteworks.com/rest/scim/ResourceTypes" \
-H "Authorization: Bearer YOUR_TOKEN"import requests
url = "https://{instance}.kiteworks.com/rest/scim/ResourceTypes"
headers = {
"Authorization": "Bearer YOUR_TOKEN",
}
response = requests.get(url, headers=headers)
print(response.json())Return a SCIM resource type
Description:
Returns the SCIM resource type corresponding to the provided ID.Precondition:
The request must be authenticated using a valid SCIM token.Response:
The requested SCIM resource type is returned if it exists.The ID/URN of the schema
The requested SCIM resource type is returned successfully.
Unauthorized.
Forbidden.
Request blocked by WAF
curl -X GET \
"https://{instance}.kiteworks.com/rest/scim/ResourceTypes/:id" \
-H "Authorization: Bearer YOUR_TOKEN"import requests
id = "VALUE" # The ID/URN of the schema
url = f"https://{{instance}}.kiteworks.com/rest/scim/ResourceTypes/{id}"
headers = {
"Authorization": "Bearer YOUR_TOKEN",
}
response = requests.get(url, headers=headers)
print(response.json())