Returns all the users of a specified organization.
string
Requirednumber
number
Returns a paged list of users of the organization
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/servicedeskapi/organization/{organizationId}/user' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
{
"_expands": [
"<string>"
],
"size": 1,
"start": 0,
"limit": 50,
"isLastPage": true,
"_links": {
"base": "<string>",
"context": "<string>",
"next": "<string>",
"prev": "<string>",
"self": "<string>"
},
"values": [
{
"name": "<string>",
"key": "<string>",
"emailAddress": "<string>",
"displayName": "<string>",
"active": true,
"timeZone": "<string>",
"_links": {
"jiraRest": "<string>",
"avatarUrls": {},
"self": "<string>"
}
}
]
}Adds users to an organization.
string
RequiredThe DTO of the users to add.
array<string>
Add User to organization was successful
1
2
3
4
5
6
7
8
curl --request POST \
--url 'http://{baseurl}/rest/servicedeskapi/organization/{organizationId}/user' \
--header 'Content-Type: application/json' \
--data '{
"usernames": [
"<string>"
]
}'Removes users from an organization.
string
RequiredThe DTO of the users to add.
array<string>
Remove User from organization was successful
1
2
3
4
5
6
7
8
curl --request DELETE \
--url 'http://{baseurl}/rest/servicedeskapi/organization/{organizationId}/user' \
--header 'Content-Type: application/json' \
--data '{
"usernames": [
"<string>"
]
}'Returns a list of organizations in the Jira instance.If the user is not an agent, the resource returns a list of organizations the user is a member of.
number
number
Returns paginated list of organizations
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/servicedeskapi/organization' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
{
"_expands": [
"<string>"
],
"size": 1,
"start": 0,
"limit": 50,
"isLastPage": true,
"_links": {
"base": "<string>",
"context": "<string>",
"next": "<string>",
"prev": "<string>",
"self": "<string>"
},
"values": [
{
"id": "<string>",
"name": "<string>",
"_links": {
"self": "<string>"
}
}
]
}To create an organization Jira administrator global permission or agent permission is required depending on the settings
The DTO of the organization to create.
string
Return the newly created organization.
1
2
3
4
5
6
7
curl --request POST \
--url 'http://{baseurl}/rest/servicedeskapi/organization' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"name": "<string>"
}'1
2
3
4
5
6
7
{
"id": "<string>",
"name": "<string>",
"_links": {
"self": "<string>"
}
}Returns an organization for a given organization ID.
string
RequiredReturns the requested organization
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/servicedeskapi/organization/{organizationId}' \
--header 'Accept: application/json'1
2
3
4
5
6
7
{
"id": "<string>",
"name": "<string>",
"_links": {
"self": "<string>"
}
}Deletes an organization for a given organization ID.
string
RequiredDelete organization was successful.
1
2
curl --request DELETE \
--url 'http://{baseurl}/rest/servicedeskapi/organization/{organizationId}'Rate this page: