...
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.
Sample response
For LDAP:
| Code Block | ||
|---|---|---|
| ||
[
{
"name": "FunctionalQA",
"disabled": false,
"externalGroupId": "CN=FunctionalQA,OU=QA"
},
{
"name": "ClientDev",
"disabled": false,
"externalGroupId": "CN=ClientDev,OU=DEV"
},
{
"name": "FullStackDev",
"disabled": false,
"externalGroupId": "CN=FullStackDev,OU=DEV"
},
{
"name": "zeSupport",
"disabled": false,
"externalGroupId": "CN=zeSupport,OU=TQS,OU=QM,OU=S,OU=Support"
},
{
"name": "TestA",
"disabled": false,
"externalGroupId": "CN=TestA,OU=DEV"
},
{
"name": "Test B",
"disabled": false,
"externalGroupId": "CN=Test B,OU=DEV"
},
{
"name": "Test1QA",
"disabled": false,
"externalGroupId": "CN=Test1QA,OU=QA"
},
{
"name": "Test2QA",
"disabled": false,
"externalGroupId": "CN=Test2QA,OU=QA"
},
{
"name": "Automation_QA",
"disabled": false,
"externalGroupId": "CN=Automation_QA,OU=QA"
}
] |
For Crowd:
| Code Block | ||
|---|---|---|
| ||
[
{
"name": "Automation_QA",
"description": "",
"disabled": false,
"externalGroupId": "Automation_QA"
},
{
"name": "crowd-administrators",
"description": "",
"disabled": false,
"externalGroupId": "crowd-administrators"
},
{
"name": "data",
"description": "32523535235",
"disabled": false,
"externalGroupId": "data"
},
{
"name": "dt",
"description": "dt",
"disabled": false,
"externalGroupId": "dt"
},
{
"name": "jira-administrators",
"description": "",
"disabled": false,
"externalGroupId": "jira-administrators"
},
{
"name": "jira-software-users",
"description": "",
"disabled": false,
"externalGroupId": "jira-software-users"
},
{
"name": "NCR Test",
"description": "",
"disabled": false,
"externalGroupId": "NCR Test"
},
{
"name": "NCR Test1",
"description": "",
"disabled": false,
"externalGroupId": "NCR Test1"
},
{
"name": "test",
"description": "",
"disabled": false,
"externalGroupId": "test"
},
{
"name": "test1",
"description": "",
"disabled": false,
"externalGroupId": "test1"
},
{
"name": "white box",
"description": "white box",
"disabled": false,
"externalGroupId": "white box"
}
] |
Import one or more groups
...
Content-Type: application/json
Sample Request
For LDAP:
| Code Block |
|---|
{ "names": [ |
...
"CN=PerformanceQA,OU=QA" ] } |
| Info |
|---|
LDAP groups must be specified by their distinguished name (DN). For example: |
For Crowd:
| Code Block | ||
|---|---|---|
| ||
{ "names": [ "Automation_QA" ] } |
Sample response
100
On success, the operation returns status code 200 and a JSON object containing the job ID.
Synchronize one or more groups
...
PUT http(s)://{ZEPHYR-SERVER}/flex/services/rest/v3/externalGroup/importGroupsAndUserssync
Headers
Content-Type: application/json
Sample Request
For LDAP:
| Code Block |
|---|
{ "names": [ |
...
"CN=PerformanceQA,OU=QA"
]
} |
For Crowd:
| Code Block | ||
|---|---|---|
| ||
{
"names": [
"crowd-administrators"
]
} |
Sample response
101
On success, the operation returns status code 200 and a JSON object containing the job ID.
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.
...