Class LicenseMetricsService

This resource represents license metrics. Use it to get available metrics for Jira licences.

See

https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-license-metrics

Hierarchy

CommonHttpService
- LicenseMetricsService

Index

Constructors

Methods

getApproximateApplicationLicenseCount getApproximateLicenseCount getLicense initialize

Constructors

constructor

new LicenseMetricsService(getClientInstance): LicenseMetricsService
Internal
Create a new instance of the service.
Parameters
- getClientInstance: (() => CommonHttpClient)
  - - (): CommonHttpClient
    - Returns CommonHttpClient
Returns LicenseMetricsService
Inherited from CommonHttpService.constructor

Methods

getApproximateApplicationLicenseCount

getApproximateApplicationLicenseCount(params): Promise<LicenseMetric>
Returns the total approximate number of user accounts for a single Jira license. Note that this information is cached with a 7-day lifecycle and could be stale at the time of call.

Permissions required: Administer Jira global permission.
Parameters
- params: {
      applicationKey:
          | "jira-core"
          | "jira-product-discovery"
          | "jira-software"
          | "jira-servicedesk";
  }
  - applicationKey:
        | "jira-core"
        | "jira-product-discovery"
        | "jira-software"
        | "jira-servicedesk"
    The ID of the application, represents a specific version of Jira.
Returns Promise<LicenseMetric>
Returned if the request is successful.

example:
```
{
  "key": "license.jira-software.approximateUserCount",
  "value": "115"
}
```
Path
GET /rest/api/3/license/approximateLicenseCount/product/{applicationKey} @scopes-current manage:jira-configuration @scopes-beta read:license:jira

See
https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-license-metrics#api-rest-api-3-license-approximatelicensecount-product-applicationkey-get

getApproximateLicenseCount

getApproximateLicenseCount(): Promise<LicenseMetric>
Returns the approximate number of user accounts across all Jira licenses. Note that this information is cached with a 7-day lifecycle and could be stale at the time of call.

Permissions required: Administer Jira global permission.

Returns Promise<LicenseMetric>
Returned if the request is successful.

example:
```
{
  "key": "license.totalApproximateUserCount",
  "value": "1000"
}
```
Path
GET /rest/api/3/license/approximateLicenseCount @scopes-current manage:jira-configuration @scopes-beta read:license:jira

See
https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-license-metrics#api-rest-api-3-license-approximatelicensecount-get

getLicense

getLicense(): Promise<License>
Returns licensing information about the Jira instance.

Permissions required: None.

Returns Promise<License>
Returned if the request is successful.

example:
```
{
  "applications": [
    {
      "id": "jira-core",
      "plan": "PAID"
    },
    {
      "id": "jira-product-discovery",
      "plan": "FREE"
    },
    {
      "id": "jira-servicedesk",
      "plan": "FREE"
    },
    {
      "id": "jira-software",
      "plan": "PAID"
    }
  ]
}
```
Path
GET /rest/api/3/instance/license @scopes-current manage:jira-configuration @scopes-beta read:license:jira

See
https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-license-metrics#api-rest-api-3-instance-license-get

`Protected` `Static`initialize

initialize(): void
Method to initialize the class. Normally used to set up validation rules.

Returns void
Overrides CommonHttpService.initialize