Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • SharePermissionInputBean

Index

Properties

Optional accountId

accountId: string

The user account ID that the filter is shared with. For a request, specify the accountId property for the user.

Optional groupname

groupname: string

The name of the group to share the filter with. Set type to group.

Optional projectId

projectId: string

The ID of the project to share the filter with. Set type to project.

Optional projectRoleId

projectRoleId: string

The ID of the project role to share the filter with. Set type to projectRole and the projectId for the project that the role is in.

Optional rights

rights: number

The rights for the share permission.

format

int32

type

type: "project" | "user" | "group" | "projectRole" | "global" | "authenticated"

The type of the share permission.Specify the type as follows:

  • user Share with a user.
  • group Share with a group. Specify groupname as well.
  • project Share with a project. Specify projectId as well.
  • projectRole Share with a project role in a project. Specify projectId and projectRoleId as well.
  • global Share globally, including anonymous users. If set, this type overrides all existing share permissions and must be deleted before any non-global share permissions is set.
  • authenticated Share with all logged-in users. This shows as loggedin in the response. If set, this type overrides all existing share permissions and must be deleted before any non-global share permissions is set.

Legend

  • Namespace
  • Variable
  • Function
  • Type alias
  • Interface
  • Property
  • Class
  • Class with type parameter
  • Enumeration

Generated using TypeDoc