Interface ApplicationRole

Details of an application role.

interface ApplicationRole {
    defaultGroups?: string[];
    defaultGroupsDetails?: GroupName[];
    defined?: boolean;
    groupDetails?: GroupName[];
    groups?: string[];
    hasUnlimitedSeats?: boolean;
    key?: string;
    name?: string;
    numberOfSeats?: number;
    platform?: boolean;
    remainingSeats?: number;
    selectedByDefault?: boolean;
    userCount?: number;
    userCountDescription?: string;
}

Properties

defaultGroups? defaultGroupsDetails? defined? groupDetails? groups? hasUnlimitedSeats? key? name? numberOfSeats? platform? remainingSeats? selectedByDefault? userCount? userCountDescription?

Properties

OptionaldefaultGroups

defaultGroups?: string[]

The groups that are granted default access for this application role. As a group's name can change, use of defaultGroupsDetails is recommended to identify a groups.

OptionaldefaultGroupsDetails

defaultGroupsDetails?: GroupName[]

The groups that are granted default access for this application role.

Optionaldefined

defined?: boolean

Deprecated.

Deprecated

OptionalgroupDetails

groupDetails?: GroupName[]

The groups associated with the application role.

Optionalgroups

groups?: string[]

The groups associated with the application role. As a group's name can change, use of groupDetails is recommended to identify a groups.

OptionalhasUnlimitedSeats

hasUnlimitedSeats?: boolean

Optionalkey

key?: string

The key of the application role.

Optionalname

name?: string

The display name of the application role.

OptionalnumberOfSeats

numberOfSeats?: number

The maximum count of users on your license.

Optionalplatform

platform?: boolean

Indicates if the application role belongs to Jira platform (jira-core).

OptionalremainingSeats

remainingSeats?: number

The count of users remaining on your license.

OptionalselectedByDefault

selectedByDefault?: boolean

Determines whether this application role should be selected by default on user creation.

OptionaluserCount

userCount?: number

The number of users counting against your license.

OptionaluserCountDescription

userCountDescription?: string

The type of users being counted against your license.

Settings

Member Visibility

On This Page

Properties