@labkey/api
    Preparing search index...

    Interface UserPermissionsContainer

    interface UserPermissionsContainer {
        children?: PermissionsContainer[];
        effectivePermissions: string[];
        groups: Group[];
        id: string;
        isInheritingPerms?: boolean;
        name: string;
        path: string;
        permissions: number;
        role: string;
        roleLabel: string;
        roles: string[];
    }

    Hierarchy (View Summary)

    Index

    Properties

    children? effectivePermissions groups id isInheritingPerms? name path permissions role roleLabel roles

    Properties

    children?: PermissionsContainer[]

    If includeSubfolders is true, then this will contain child containers.

    effectivePermissions: string[]

    An array of effective permission unique names the user has in this container.

    groups: Group[]

    An array of group objects.

    id: string

    The container id.

    isInheritingPerms?: boolean

    True if the container is inheriting permissions from its parent. This is not always provided.

    name: string

    The container name.

    path: string

    The container path.

    permissions: number

    The permissions the current user has in the container.

    role: string

    The user's role value (e.g., 'READER'). Use this property for programmatic checks.

    roleLabel: string

    A description of the group's permission role. This will correspond to the visible labels shown on the permissions page (e.g., 'Admin (all permissions)'.

    roles: string[]

    An array of role unique names that this group is playing in the container. This replaces the existing roleLabel, role and permissions properties. Groups may now play multiple roles in a container and each role grants the user a set of permissions. Use getRoles to retrieve information about the roles, including which permissions are granted by each role.

    Settings

    Member Visibility

    On This Page

    Properties