Interface BulkTransitionCombinationEntry

interface BulkTransitionCombinationEntry {
    combinationId: string;
    permissions: BulkTransitionDecodedPermission[];
    principalCount: number;
    principalTypes: (
        | "USER"
        | "GROUP"
        | "GUEST"
        | "ANONYMOUS"
        | "ALL_LICENSED_USERS_USER_CLASS"
        | "ALL_PRODUCT_ADMINS_USER_CLASS"
        | "APP"
        | "TEAM")[];
    spaceCount: number;
}

Hierarchy

  • Record<string, unknown>
    • BulkTransitionCombinationEntry

Properties

combinationId permissions principalCount principalTypes spaceCount

Properties

combinationId

combinationId: string

The opaque id identifying this unique combination of space permissions. Pass directly to the bulk role-assignments or access-removals endpoints.

permissions

permissions: BulkTransitionDecodedPermission[]

The decoded space permissions that make up this combination.

principalCount

principalCount: number

Number of principals (users / groups / etc.) that currently have this combination.

principalTypes

principalTypes: (
    | "USER"
    | "GROUP"
    | "GUEST"
    | "ANONYMOUS"
    | "ALL_LICENSED_USERS_USER_CLASS"
    | "ALL_PRODUCT_ADMINS_USER_CLASS"
    | "APP"
    | "TEAM")[]

The principal types that currently hold this combination and can be reassigned via the bulk role-assignments endpoint. Use this to know which principalType entries are valid to include in the bulk-assign request for this combination.

spaceCount

spaceCount: number

Number of spaces that currently have this combination.

Settings

Member Visibility

On This Page

Properties