Interface BulkGetGroups

interface BulkGetGroups {
    accessType?: string;
    applicationKey?: string;
    groupId?: string[];
    groupName?: string[];
    maxResults?: number;
    startAt?: number;
}

Properties

accessType? applicationKey? groupId? groupName? maxResults? startAt?

Properties

Optional accessType

accessType?: string

The access level of a group. Valid values: 'site-admin', 'admin', 'user'.

Optional applicationKey

applicationKey?: string

The application key of the product user groups to search for. Valid values: 'jira-servicedesk', 'jira-software', 'jira-product-discovery', 'jira-core'.

Optional groupId

groupId?: string[]

The ID of a group. To specify multiple IDs, pass multiple groupId parameters. For example, groupId=5b10a2844c20165700ede21g&groupId=5b10ac8d82e05b22cc7d4ef5.

Optional groupName

groupName?: string[]

The name of a group. To specify multiple names, pass multiple groupName parameters. For example, groupName=administrators&groupName=jira-software-users.

Optional maxResults

maxResults?: number

The maximum number of items to return per page.

Optional startAt

startAt?: number

The index of the first item to return in a page of results (page offset).

Settings

Member Visibility

Theme

On This Page

accessTypeapplicationKeygroupIdgroupNamemaxResultsstartAt