Searching the Help
To search for information in the Help, type a word or phrase in the Search box. When you enter a group of words, OR is inferred. You can use Boolean operators to refine your search.
Results returned are case insensitive. However, results ranking takes case into account and assigns higher scores to case matches. Therefore, a search for "cats" followed by a search for "Cats" would return the same number of Help topics, but the order in which the topics are listed would be different.
Search for | Example | Results |
---|---|---|
A single word | cat
|
Topics that contain the word "cat". You will also find its grammatical variations, such as "cats". |
A phrase. You can specify that the search results contain a specific phrase. |
"cat food" (quotation marks) |
Topics that contain the literal phrase "cat food" and all its grammatical variations. Without the quotation marks, the query is equivalent to specifying an OR operator, which finds topics with one of the individual words instead of the phrase. |
Search for | Operator | Example |
---|---|---|
Two or more words in the same topic |
|
|
Either word in a topic |
|
|
Topics that do not contain a specific word or phrase |
|
|
Topics that contain one string and do not contain another | ^ (caret) |
cat ^ mouse
|
A combination of search types | ( ) parentheses |
|
- Developer reference
- Overview of the REST API
- Connect to the REST API
- Authentication endpoint service
- Single record APIs
- Record bulk update and collection APIs
- REST API queries
- REST API collection query protocol
- Analytics REST API
- Manage Persons API
- BI Integration API
- Case Exchange REST API
- Encryption domain API
- Comments API
- REST API use-case scenario - import REST API
Encryption domain API
The following APIs are available for use in connection with encryption domains:
Revoke user from all encryption domains
Enter the following DELETE request URI:
https://<serverAddress>/rest/<tenant-id>/encryption/key_chain/<user-id>
There are no parameters for this URI.
The user's credentials are revoked for all encryption domains.
Revoke user from a specific encryption domain
Enter the following DELETE request URI:
https://<serverAddress>/rest/<tenant-id>/encryption/key_chain/<user-id>/domains/<domain-id>
where the domain-id is the ID of the required encryption domain. You can get the domain ID using the List encryption domains API.
There are no parameters for this URI.
The user's credentials are revoked for the specified encryption domain.
List encryption domains
Enter the following GET request URI:
https://<serverAddress>/rest/<tenant-id>/encryption/domains
There are no parameters for this URI.
The API returns all the encryption domains defined on the tenant.
The following is an example of the structure of the returned data in JSON format:
{ "id": "56826bbb637d6a6db8bee805", "Name": "d1", "DomainId": "2", "DisplayLabelKey": "encryption_messages_a53be345-4aa5-45f1-b3b7-d1c5811c90e2", "CreatedTime": 1451387835788, "Owner": "10015", "AllowedGroups": [{ "GroupId": "10005", "GroupProperties": { "LastUpdateTime": 1451220162383, "Id": "10005" } }], "NotificationOwner": "Both", "IsEnabled": true }
The value in the DomainId property is the required value in the Revoke a user from a specific encryption domain API.
Note Tenant admin permission is required to run the encryption domain APIs.
Related topics