Jira.js - Jira Cloud API library
    Preparing search index...

    Interface SharePermissionInput

    interface SharePermissionInput {
        accountId?: string;
        groupId?: string;
        groupname?: string;
        projectId?: string;
        projectRoleId?: string;
        rights?: number;
        type: string;
    }

    Hierarchy (View Summary)

    Index

    Properties

    accountId?: string

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

    groupId?: string

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

    groupname?: string

    The name of the group to share the filter with. Set type to group. Please note that the name of a group is mutable, to reliably identify a group use groupId.

    projectId?: string

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

    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.

    rights?: number

    The rights for the share permission.

    type: string

    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.