The payload to create a permission scheme

interface PermissionPayloadDto {
    addAddonRole?: boolean;
    description?: string;
    grants?: PermissionGrantDto[];
    name?: string;
    onConflict?: "USE" | "NEW" | "FAIL";
    pcri?: ProjectCreateResourceIdentifier;
}

Properties

addAddonRole?: boolean

Configuration to generate addon role. Default is false if null

description?: string

The description of the permission scheme

List of permission grants

name?: string

The name of the permission scheme

onConflict?: "USE" | "NEW" | "FAIL"

The strategy to use when there is a conflict with an existing permission scheme. FAIL - Fail execution, this always needs to be unique; USE - Use the existing entity and ignore new entity parameters; NEW - If the entity exist, try and create a new one with a different name

Every project-created entity has an ID that must be unique within the scope of the project creation. PCRI (Project Create Resource Identifier) is a standard format for creating IDs and references to other project entities. PCRI format is defined as follows: pcri:\[entityType\]:\[type\]:\[entityId\] entityType - the type of an entity, e.g. status, role, workflow type - PCRI type, either id - The ID of an entity that already exists in the target site, or ref - A unique reference to an entity that is being created entityId - entity identifier, if type is id - must be an existing entity ID that exists in the Jira site, if ref - must be unique across all entities in the scope of this project template creation

pcri:permissionScheme:id:10001