Skip to content

Function: getApplicationRole() ​

ts
function getApplicationRole(
   client, 
   parameters, 
   options?
): Promise<{
[key: string]: unknown;
  defaultGroups?: string[];
  defaultGroupsDetails?: object[];
  defined?: boolean;
  groupDetails?: object[];
  groups?: string[];
  hasUnlimitedSeats?: boolean;
  key?: string;
  name?: string;
  numberOfSeats?: number;
  platform?: boolean;
  remainingSeats?: number;
  selectedByDefault?: boolean;
  userCount?: number;
  userCountDescription?: string;
}>;

Defined in: src/cloud/api/applicationRoles.ts:30

Returns an application role.

Permissions required:Administer Jira global permission.

Parameters ​

ParameterTypeDescription
clientClient-
parameters{ key: string; }-
parameters.keystringThe key of the application role. Use the Get all application roles operation to get the key for each application role.
options?RequestOptions-

Returns ​

Promise<{ [key: string]: unknown; defaultGroups?: string[]; defaultGroupsDetails?: object[]; defined?: boolean; groupDetails?: object[]; groups?: string[]; hasUnlimitedSeats?: boolean; key?: string; name?: string; numberOfSeats?: number; platform?: boolean; remainingSeats?: number; selectedByDefault?: boolean; userCount?: number; userCountDescription?: string; }>