Class ApplicationRolesService

This resource represents application roles. Use it to get details of an application role or all application roles.

See

https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-application-roles

Hierarchy

  • CommonHttpService
    • ApplicationRolesService

Constructors

constructor

Methods

getAllApplicationRoles getApplicationRole initialize

Constructors

constructor

  • new ApplicationRolesService(getClientInstance): ApplicationRolesService
  • Internal

    Create a new instance of the service.

    Parameters

    • getClientInstance: (() => CommonHttpClient)
        • (): CommonHttpClient

        • Returns CommonHttpClient

    Returns ApplicationRolesService

Methods

getAllApplicationRoles

  • getAllApplicationRoles(): Promise<ApplicationRole[]>

  • Returns all application roles. In Jira, application roles are managed using the Application access configuration page.

    Permissions required: Administer Jira global permission.

    Returns Promise<ApplicationRole[]>

    Returned if the request is successful.

    example:

    [
      {
        "defaultGroups": [
          "jira-software-users"
        ],
        "defaultGroupsDetails": [
          {
            "groupId": "276f955c-63d7-42c8-9520-92d01dca0625",
            "name": "jira-software-users",
            "self": "https://your-domain.atlassian.net/rest/api/3/group?groupId=276f955c-63d7-42c8-9520-92d01dca0625"
          }
        ],
        "defined": false,
        "groupDetails": [
          {
            "groupId": "42c8955c-63d7-42c8-9520-63d7aca0625",
            "name": "jira-testers",
            "self": "https://your-domain.atlassian.net/rest/api/3/group?groupId=42c8955c-63d7-42c8-9520-63d7aca0625"
          },
          {
            "groupId": "276f955c-63d7-42c8-9520-92d01dca0625",
            "name": "jira-software-users",
            "self": "https://your-domain.atlassian.net/rest/api/3/group?groupId=276f955c-63d7-42c8-9520-92d01dca0625"
          }
        ],
        "groups": [
          "jira-software-users",
          "jira-testers"
        ],
        "hasUnlimitedSeats": false,
        "key": "jira-software",
        "name": "Jira Software",
        "numberOfSeats": 10,
        "platform": false,
        "remainingSeats": 5,
        "selectedByDefault": false,
        "userCount": 5,
        "userCountDescription": "5 developers"
      },
      {
        "defaultGroups": [
          "jira-core-users"
        ],
        "defaultGroupsDetails": [
          {
            "groupId": "92d01dca0625-42c8-42c8-9520-276f955c",
            "name": "jira-core-users",
            "self": "https://your-domain.atlassian.net/rest/api/3/group?groupId=92d01dca0625-42c8-42c8-9520-276f955c"
          }
        ],
        "defined": false,
        "groupDetails": [
          {
            "groupId": "92d01dca0625-42c8-42c8-9520-276f955c",
            "name": "jira-core-users",
            "self": "https://your-domain.atlassian.net/rest/api/3/group?groupId=92d01dca0625-42c8-42c8-9520-276f955c"
          }
        ],
        "groups": [
          "jira-core-users"
        ],
        "hasUnlimitedSeats": false,
        "key": "jira-core",
        "name": "Jira Core",
        "numberOfSeats": 1,
        "platform": true,
        "remainingSeats": 1,
        "selectedByDefault": false,
        "userCount": 0,
        "userCountDescription": "0 users"
      }
    ]

    Path

    GET /rest/api/3/applicationrole

    See

    https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-application-roles#api-rest-api-3-applicationrole-get

getApplicationRole

  • getApplicationRole(params): Promise<ApplicationRole>

  • Returns an application role.

    Permissions required: Administer Jira global permission.

    Parameters

    • params: {
          key: string;
      }
      • key: string

        The key of the application role. Use the Get all application roles operation to get the key for each application role.

    Returns Promise<ApplicationRole>

    Returned if the request is successful.

    example:

    {
      "defaultGroups": [
        "jira-software-users"
      ],
      "defaultGroupsDetails": [
        {
          "groupId": "276f955c-63d7-42c8-9520-92d01dca0625",
          "name": "jira-software-users",
          "self": "https://your-domain.atlassian.net/rest/api/3/group?groupId=276f955c-63d7-42c8-9520-92d01dca0625"
        }
      ],
      "defined": false,
      "groupDetails": [
        {
          "groupId": "42c8955c-63d7-42c8-9520-63d7aca0625",
          "name": "jira-testers",
          "self": "https://your-domain.atlassian.net/rest/api/3/group?groupId=42c8955c-63d7-42c8-9520-63d7aca0625"
        },
        {
          "groupId": "276f955c-63d7-42c8-9520-92d01dca0625",
          "name": "jira-software-users",
          "self": "https://your-domain.atlassian.net/rest/api/3/group?groupId=276f955c-63d7-42c8-9520-92d01dca0625"
        }
      ],
      "groups": [
        "jira-software-users",
        "jira-testers"
      ],
      "hasUnlimitedSeats": false,
      "key": "jira-software",
      "name": "Jira Software",
      "numberOfSeats": 10,
      "platform": false,
      "remainingSeats": 5,
      "selectedByDefault": false,
      "userCount": 5,
      "userCountDescription": "5 developers"
    }

    Path

    GET /rest/api/3/applicationrole/{key}

    See

    https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-application-roles#api-rest-api-3-applicationrole-key-get

Protected Staticinitialize

  • initialize(): void

  • Method to initialize the class. Normally used to set up validation rules.

    Returns void

Settings

Member Visibility

On This Page

Constructors
Methods