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

    Interface CreatePermissionScheme

    interface CreatePermissionScheme {
        description?: string;
        expand?:
            | string
            | string[]
            | ("user" | "group" | "projectRole" | "all" | "field" | "permissions")[];
        id?: number;
        name: string;
        permissions?: Version2Models.PermissionGrant[];
        scope?: Version2Models.Scope;
        self?: string;
    }

    Hierarchy

    Index

    Properties

    description?: string

    A description for the permission scheme.

    expand?:
        | string
        | string[]
        | ("user" | "group" | "projectRole" | "all" | "field" | "permissions")[]

    Use expand to include additional information in the response. This parameter accepts a comma-separated list. Note that permissions are always included when you specify any value. Expand options include:

    • all Returns all expandable information.
    • field Returns information about the custom field granted the permission.
    • group Returns information about the group that is granted the permission.
    • permissions Returns all permission grants for each permission scheme.
    • projectRole Returns information about the project role granted the permission.
    • user Returns information about the user who is granted the permission.
    id?: number

    The ID of the permission scheme.

    name: string

    The name of the permission scheme. Must be unique.

    The permission scheme to create or update. See About permission schemes and grants for more information.

    self?: string

    The URL of the permission scheme.