| Panel | ||||||
|---|---|---|---|---|---|---|
| ||||||
Starting October 11, 2024 (Zephyr Enterprise 8.2), the Zephyr Enterprise documentation moved from its current location on Atlassian to a dedicated, standalone Zephyr Enterprise documentation page. Please see: https://support.smartbear.com/zephyr-enterprise/docs/en/zephyr-enterprise/zephyr-rest-api/import---synchronize-ldap-crowd-groups.html |
If your Zephyr administrator set up LDAP or Crowd for authentication, you can use Zephyr Enterprise REST API to programmatically import LDAP or Crowd groups to Zephyr and synchronize them as, for example, part of some automated operations.
...
The base URL for API calls is:
http(s)://SERVER[:PORT]/flex/services/rest/latest
or in case of Zephyr Enterprise Cloud instances:
https://YOUR_SUBDOMAIN.yourzephyr.com/flex/services/rest/latest
Authentication
You can authenticate your requests by using one of the methods described in the Zephyr REST API topic.
Get a list of groups
Request URL
...
GET
...
http(s)://{ZEPHYR-SERVER}/flex/services/rest/v3/externalGroup/search?name=SEARCH_STRING&pagesize=100
Request parameters
name - (optional) a substring that is part of the sought-for name. If this parameter is not specified, all the groups will be fetched.
pagesize - (optional) the number of groups to be fetched. The default number is 100; the maximum number is 499.
...
Import one or more groups
Request URL
...
POST
...
http(s)://{ZEPHYR-SERVER}/flex/services/rest/v3/externalGroup/importGroupsAndUsers
Headers
Content-Type: application/json
...
| Code Block | ||
|---|---|---|
| ||
{
"names": [
"Automation_QA"
]
} |
...
Response
100
On success, the operation returns status code 200 and a JSON object containing the job ID in the response body (for example, 100). To get the job details and progress, send the following GET request:
...
http://yourzephyr.com/flex/services/rest/v3/jobprogress/100
For information on other response codes, see below.
Synchronize one or more groups
Synchronization is needed when a new group is added to or an existing group is deleted from LDAP or Crowd. This It should be done to update the list of groups in Zephyr.
...
| Code Block | ||
|---|---|---|
| ||
{
"names": [
"crowd-administrators"
]
} |
Sample response
...
Response
On success, the operation returns status code 200 and a JSON object containing the job ID in the response body (for example, 101). To get the job details and progress, send the following GET request:
...
http://yourzephyr.com/flex/services/rest/v3/jobprogress/101
For information on other response codes, see below.
Response codes
HTTP Status Code | Description |
|---|---|
200 | The request completed successfully. |
400 | Bad request. |
401 | The authentication token is missing. |
403 | The user has no permissions to perform this operation. |
500 | Unknown internal error. |