If your Zephyr administrator set up LDAP or Crowd is set up for authentication in Zephyr, 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.
Base URL
The base URL for API calls is:
|
or in case of Zephyr Enterprise Cloud instances:
|
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
| Code Block | ||
|---|---|---|
| ||
GET http(s)://{ZEPHYR-SERVER}/flex/services/rest/v3/externalGroup/search?name=SEARCH_STRING&pagesize=100 |
Request parameters
name - (optional) a substring ( that is , “contains” or “begins with”)part of the sought-for name. If no name is 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.
| Info |
|---|
Both query parameters are optional. |
Import one or more groups
...
{"names": ["GroupName1", "GroupName2", ...]}
Authentication
You can authenticate your requests by using one of the methods described in the Zephyr REST API topic.
Response
On success, the operations return status code 200 and a JSON object containing metadata and found results. The structure of these results varies depending on the sought-for entities, items and so on.
...