This resource represents organizations, including their entitlements and detail fields. Use this to manage organization details and field information. To manage an organization, please refer to the Organization group API.
Returns all organization detail fields, including their configuration. You can use the get organization API to get details for a particular organization.
Permissions required: Administer Jira global permission.
read:organization.detail-field:jira-service-managementThis request has no parameters.
Returns a list of organization detail fields.
1
2
3
4
curl --request GET \
--url 'https://api.atlassian.com/jsm/csm/cloudid/{cloudId}/api/v1/organization/details' \
--header 'Authorization: Bearer <access_token>' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
{
"results": [
{
"name": "Region",
"type": {
"name": "SELECT",
"options": [
"AU",
"EU",
"US"
]
},
"configuration": {
"position": 1
}
}
]
}Creates an organization detail field. You can create up to 50 detail fields.
Permissions required: Administer Jira global permission.
write:organization.detail-field:jira-service-managementstring
RequiredDetailFieldType
RequiredReturns the created detail field.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
curl --request POST \
--url 'https://api.atlassian.com/jsm/csm/cloudid/{cloudId}/api/v1/organization/details' \
--header 'Authorization: Bearer <access_token>' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"name": "Region",
"type": {
"name": "SELECT",
"options": [
"AU",
"EU",
"US"
]
}
}'1
2
3
4
5
6
7
8
9
10
11
{
"name": "Region",
"type": {
"name": "SELECT",
"options": [
"AU",
"EU",
"US"
]
}
}Renames an organization detail field and/or changes the available options for SELECT or MULTISELECT fields.
Permissions required: Administer Jira global permission.
write:organization.detail-field:jira-service-managementstring
Requiredstring
Requiredarray<string>
Returns the edited organization detail field.
1
2
3
4
5
6
7
8
9
10
11
12
13
curl --request PUT \
--url 'https://api.atlassian.com/jsm/csm/cloudid/{cloudId}/api/v1/organization/details/{fieldName}' \
--header 'Authorization: Bearer <access_token>' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"name": "Region",
"options": [
"AU",
"EU",
"US"
]
}'1
2
3
4
5
6
7
8
9
10
11
{
"name": "Region",
"type": {
"name": "SELECT",
"options": [
"AU",
"EU",
"US"
]
}
}Deletes an organization detail field and all values stored for it for all organizations. You cannot restore a detail field once it has been deleted.
Permissions required: Administer Jira global permission.
delete:organization.detail-field:jira-service-managementstring
RequiredReturns no response if the organization detail field is deleted.
1
2
3
curl --request DELETE \
--url 'https://api.atlassian.com/jsm/csm/cloudid/{cloudId}/api/v1/organization/details/{fieldName}' \
--header 'Authorization: Bearer <access_token>'Returns an organization, including its details. You can get entitlements for an organization using the get organization entitlements API.
Permissions required: Jira Service Management agent.
read:organization:jira-service-managementread:organization.detail:jira-service-managementstring
RequiredReturns the requested organization.
1
2
3
4
curl --request GET \
--url 'https://api.atlassian.com/jsm/csm/cloudid/{cloudId}/api/v1/organization/{organizationId}' \
--header 'Authorization: Bearer <access_token>' \
--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
{
"id": "123",
"name": "Atlassian",
"details": [
{
"id": "321",
"name": "Region",
"type": {
"name": "SELECT",
"options": [
"AU",
"EU",
"US"
]
},
"values": [
"EU"
],
"configuration": {
"position": 1
}
}
]
}Permissions required: Jira Service Management agent.
write:organization.detail:jira-service-managementstring
Requiredstring
Requiredarray<string>
Returns the updated field.
1
2
3
4
5
6
7
8
9
10
curl --request PUT \
--url 'https://api.atlassian.com/jsm/csm/cloudid/{cloudId}/api/v1/organization/{organizationId}/details?fieldName=Region' \
--header 'Authorization: Bearer <access_token>' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"values": [
"EU"
]
}'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
{
"id": "321",
"name": "Region",
"type": {
"name": "SELECT",
"options": [
"AU",
"EU",
"US"
]
},
"values": [
"EU"
]
}Returns a list of the organization's entitlements, along with their details.
Permissions required: Jira Service Management agent.
read:organization:entitlement:jira-service-managementstring
Requiredstring
Returns a list of entitlements.
array<Entitlement>
1
2
3
4
curl --request GET \
--url 'https://api.atlassian.com/jsm/csm/cloudid/{cloudId}/api/v1/organization/{organizationId}/entitlement' \
--header 'Authorization: Bearer <access_token>' \
--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
[
{
"id": "3858a61a-d337-42e6-993e-e13e1c366d4f",
"product": {
"id": "3858a61a-d337-42e6-993e-e13e1c366d4f",
"name": "Acme Widget"
},
"entitledEntity": {
"id": "123",
"type": "CUSTOMER"
},
"details": [
{
"id": "321",
"name": "Region",
"type": {
"name": "SELECT"
},
"values": [
"EU"
],
"configuration": {}
}
]
}
]Permissions required: Jira Service Management agent.
write:organization:entitlement:jira-service-managementstring
RequiredThe ID of the associated product, as a UUID.
string
RequiredReturns the created entitlement.
1
2
3
4
5
6
7
8
curl --request POST \
--url 'https://api.atlassian.com/jsm/csm/cloudid/{cloudId}/api/v1/organization/{organizationId}/entitlement' \
--header 'Authorization: Bearer <access_token>' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"productId": "3858a61a-d337-42e6-993e-e13e1c366d4f"
}'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
{
"id": "3858a61a-d337-42e6-993e-e13e1c366d4f",
"product": {
"id": "3858a61a-d337-42e6-993e-e13e1c366d4f",
"name": "Acme Widget"
},
"entitledEntity": {
"id": "123",
"type": "CUSTOMER"
},
"details": [
{
"id": "321",
"name": "Region",
"type": {
"name": "SELECT",
"options": [
"AU",
"EU",
"US"
]
},
"values": [
"EU"
],
"configuration": {
"position": 1
}
}
]
}Rate this page: