Interface FoundGroup

A group found in a search.

interface FoundGroup {
    avatarUrl?: string;
    groupId?: string;
    html?: string;
    labels?: GroupLabel[];
    managedBy?:
        | "EXTERNAL"
        | "ADMINS"
        | "TEAM_MEMBERS"
        | "OPEN";
    name?: string;
    usageType?: "USERBASE_GROUP" | "TEAM_COLLABORATION" | "ADMIN_OVERSIGHT";
}

Properties

avatarUrl? groupId? html? labels? managedBy? name? usageType?

Properties

OptionalavatarUrl

avatarUrl?: string

Avatar url for the group/team if present.

OptionalgroupId

groupId?: string

The ID of the group, which uniquely identifies the group across all Atlassian products. For example, 952d12c3-5b5b-4d04-bb32-44d383afc4b2.

Optionalhtml

html?: string

The group name with the matched query string highlighted with the HTML bold tag.

Optionallabels

labels?: GroupLabel[]

OptionalmanagedBy

managedBy?:
    | "EXTERNAL"
    | "ADMINS"
    | "TEAM_MEMBERS"
    | "OPEN"

Describes who/how the team is managed. The possible values are * external - when team is synced from an external directory like SCIM or HRIS, and team members cannot be modified. * admins - when a team is managed by an admin (team members can only be modified by admins). * team-members - managed by existing team members, new members need to be invited to join. * open - anyone can join or modify this team.

Optionalname

name?: string

The name of the group. The name of a group is mutable, to reliably identify a group use ``groupId.

OptionalusageType

usageType?: "USERBASE_GROUP" | "TEAM_COLLABORATION" | "ADMIN_OVERSIGHT"

Describes the type of group. The possible values are * team-collaboration - A platform team managed in people directory. * userbase-group - a group of users created in adminhub. * admin-oversight - currently unused.

Settings

Member Visibility

On This Page

Properties