GET

Get directories

Returns list of directories linked to the users who are consuming licenses in the given application, matching provided version of data and subtype of the application, if it's Jira

Request

Path parameters

applicationId

integer

Required

Query parameters

start

integer

limit

integer

version

integer

jiraType

string

Responses

returned if the list of directories was successfully retrieved

application/json

any

GET/rest/admin/1.0/licensing/{applicationId}/directories
1 2 3 curl --request GET \ --url 'http://{baseurl}/rest/rest/admin/1.0/licensing/{applicationId}/directories' \ --header 'Accept: application/json'
200Response
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 { "values": [ { "id": "743", "name": "Crowd users directory", "isLocalCrowd": true }, { "id": "9714", "name": "My awesome directory", "isLocalCrowd": false } ], "size": 2, "start": 2, "limit": 2, "isLastPage": false }
GET

Get Jira types

Returns list of application sub-types available for the given Jira application

Request

Path parameters

applicationId

integer

Required

Query parameters

version

integer

Responses

returned if Jira subtypes were successfully retrieved

application/json

any

GET/rest/admin/1.0/licensing/{applicationId}/jira-types
1 2 3 curl --request GET \ --url 'http://{baseurl}/rest/rest/admin/1.0/licensing/{applicationId}/jira-types' \ --header 'Accept: application/json'
200Response
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 { "values": [ { "key": "jira-servicedesk", "displayName": "Jira Service Desk" }, { "key": "jira-software", "displayName": "Jira Software" }, { "key": "bitbucket", "displayName": "Bitbucket" }, { "key": "confluence", "displayName": "Confluence" }, { "key": "jira-core", "displayName": "Jira Core" } ] }
GET

Export users

Returns license consuming users for given application, matching provided restrictions

Request

Path parameters

applicationId

integer

Required

Query parameters

search

string

directoryId

string

jiraType

string

lastLoginBefore

integer

searchVersion

integer

Responses

returned if download was performed successfully

GET/rest/admin/1.0/licensing/{applicationId}/licensed-users/download
1 2 curl --request GET \ --url 'http://{baseurl}/rest/rest/admin/1.0/licensing/{applicationId}/licensed-users/download'
POST

Search users

Searches license consuming users along with the total count of users for given application, matching provided restrictions

Request

Path parameters

applicationId

integer

Required

Query parameters

start

integer

limit

integer

Request bodyapplication/json

search criteria

directoryId

string

jiraType

string

lastLoginBefore

integer

search

string

searchVersion

integer

Responses

returned if the search was performed successfully and licensed users were successfully retrieved

application/json

any

POST/rest/admin/1.0/licensing/{applicationId}/licensed-users/search
1 2 3 4 5 6 7 8 9 10 11 curl --request POST \ --url 'http://{baseurl}/rest/rest/admin/1.0/licensing/{applicationId}/licensed-users/search' \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "search": "jon", "directoryId": "5324", "jiraType": "jira-software", "lastLoginBefore": 1550008800000, "searchVersion": 3947145 }'
200Response
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 { "values": [ { "id": 4324, "lastLogin": 1556226000000, "username": "jonbovi", "fullName": "Jon Bovi", "email": "jon@bovi.com" }, { "id": 1528, "lastLogin": 1557694800000, "username": "johnkowal", "fullName": "John Kowal", "email": "john@kowal.com" } ], "size": 2, "start": 21, "limit": 2, "totalCount": 150, "isLastPage": false, "upToDate": true }
GET

Get licensing summary

Return the licensing summary if available

Request

Path parameters

applicationId

integer

Required

Query parameters

version

integer

jiraType

string

Responses

returned if licensing summary was successfully retrieved

application/json

any

GET/rest/admin/1.0/licensing/{applicationId}/summary
1 2 3 curl --request GET \ --url 'http://{baseurl}/rest/rest/admin/1.0/licensing/{applicationId}/summary' \ --header 'Accept: application/json'
200Response
1 2 3 4 5 6 7 8 9 { "maximumUserLimit": 300, "totalLicensedUsers": 24, "numberOfDirectories": 2, "timestamp": 1559768400000, "version": 5347545, "jiraType": "jira-software", "status": "LOADING" }

Rate this page: