The payload used to create a project role. It is optional for CMP projects, as a default role actor will be provided. TMP will add new role actors to the table.

interface RolePayload {
    defaultActors?: ProjectCreateResourceIdentifier[];
    description?: string;
    name?: string;
    onConflict?: "USE" | "NEW" | "FAIL";
    pcri?: ProjectCreateResourceIdentifier;
    type?: "HIDDEN" | "VIEWABLE" | "EDITABLE";
}

Properties

The default actors for the role. By adding default actors, the role will be added to any future projects created

[pcri:user:id:1234]
description?: string

The description of the role

name?: string

The name of the role

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

The strategy to use when there is a conflict with an existing project role. FAIL - Fail execution, this always needs to be unique; USE - Use the existing entity and ignore new entity parameters

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
type?: "HIDDEN" | "VIEWABLE" | "EDITABLE"

The type of the role. Only used by project-scoped project

EDITABLE