Function updatePermissionScheme

Parameters

• client: Client
• parameters: {
      body: {
          description?: string;
          expand?: string;
          id?: number;
          name: string;
          permissions?: {
              holder?: {
                  expand?: string;
                  parameter?: string;
                  type: string;
                  value?: string;
                  [key: string]: unknown;
              };
              id?: number;
              permission?: string;
              self?: string;
              [key: string]: unknown;
          }[];
          scope?: {
              project?: {
                  avatarUrls?: {
                      "16x16"?: string;
                      "24x24"?: string;
                      "32x32"?: string;
                      "48x48"?: string;
                      [key: string]: unknown;
                  };
                  id?: string;
                  key?: string;
                  name?: string;
                  projectCategory?: {
                      description?: string;
                      id?: string;
                      name?: string;
                      self?: string;
                      [key: string]: unknown;
                  };
                  projectTypeKey?: | string & {}
                  | "software"
                  | "service_desk"
                  | "business"
                  | "product_discovery"
                  | "customer_service";
                  self?: string;
                  simplified?: boolean;
                  [key: string]: unknown;
              };
              type?: string & {}
              | "PROJECT"
              | "TEMPLATE";
              [key: string]: unknown;
          };
          self?: string;
          [key: string]: unknown;
      };
      expand?: | string
      | string[]
      | string & {}
      | (
          | "all"
          | "user"
          | "group"
          | "field"
          | string & {}
          | "permissions"
          | "projectRole"
      )[];
      schemeId: number;
  }

  • body: {
        description?: string;
        expand?: string;
        id?: number;
        name: string;
        permissions?: {
            holder?: {
                expand?: string;
                parameter?: string;
                type: string;
                value?: string;
                [key: string]: unknown;
            };
            id?: number;
            permission?: string;
            self?: string;
            [key: string]: unknown;
        }[];
        scope?: {
            project?: {
                avatarUrls?: {
                    "16x16"?: string;
                    "24x24"?: string;
                    "32x32"?: string;
                    "48x48"?: string;
                    [key: string]: unknown;
                };
                id?: string;
                key?: string;
                name?: string;
                projectCategory?: {
                    description?: string;
                    id?: string;
                    name?: string;
                    self?: string;
                    [key: string]: unknown;
                };
                projectTypeKey?: | string & {}
                | "software"
                | "service_desk"
                | "business"
                | "product_discovery"
                | "customer_service";
                self?: string;
                simplified?: boolean;
                [key: string]: unknown;
            };
            type?: string & {}
            | "PROJECT"
            | "TEMPLATE";
            [key: string]: unknown;
        };
        self?: string;
        [key: string]: unknown;
    }

    • Optionaldescription?: string

      A description for the permission scheme.

    • Optionalexpand?: string

      The expand options available for the permission scheme.

    • Optionalid?: number

      The ID of the permission scheme.

    • name: string

      The name of the permission scheme. Must be unique.

    • Optionalpermissions?: {
          holder?: {
              expand?: string;
              parameter?: string;
              type: string;
              value?: string;
              [key: string]: unknown;
          };
          id?: number;
          permission?: string;
          self?: string;
          [key: string]: unknown;
      }[]

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

    • Optionalscope?: {
          project?: {
              avatarUrls?: {
                  "16x16"?: string;
                  "24x24"?: string;
                  "32x32"?: string;
                  "48x48"?: string;
                  [key: string]: unknown;
              };
              id?: string;
              key?: string;
              name?: string;
              projectCategory?: {
                  description?: string;
                  id?: string;
                  name?: string;
                  self?: string;
                  [key: string]: unknown;
              };
              projectTypeKey?: | string & {}
              | "software"
              | "service_desk"
              | "business"
              | "product_discovery"
              | "customer_service";
              self?: string;
              simplified?: boolean;
              [key: string]: unknown;
          };
          type?: string & {}
          | "PROJECT"
          | "TEMPLATE";
          [key: string]: unknown;
      }

      • Optionalproject?: {
            avatarUrls?: {
                "16x16"?: string;
                "24x24"?: string;
                "32x32"?: string;
                "48x48"?: string;
                [key: string]: unknown;
            };
            id?: string;
            key?: string;
            name?: string;
            projectCategory?: {
                description?: string;
                id?: string;
                name?: string;
                self?: string;
                [key: string]: unknown;
            };
            projectTypeKey?: | string & {}
            | "software"
            | "service_desk"
            | "business"
            | "product_discovery"
            | "customer_service";
            self?: string;
            simplified?: boolean;
            [key: string]: unknown;
        }

        • OptionalavatarUrls?: {
              "16x16"?: string;
              "24x24"?: string;
              "32x32"?: string;
              "48x48"?: string;
              [key: string]: unknown;
          }

          • Optional16x16?: string

            The URL of the item's 16x16 pixel avatar.

          • Optional24x24?: string

            The URL of the item's 24x24 pixel avatar.

          • Optional32x32?: string

            The URL of the item's 32x32 pixel avatar.

          • Optional48x48?: string

            The URL of the item's 48x48 pixel avatar.

        • Optionalid?: string

          The ID of the project.

        • Optionalkey?: string

          The key of the project.

        • Optionalname?: string

          The name of the project.

        • OptionalprojectCategory?: {
              description?: string;
              id?: string;
              name?: string;
              self?: string;
              [key: string]: unknown;
          }

          • Optionaldescription?: string

            The name of the project category.

          • Optionalid?: string

            The ID of the project category.

          • Optionalname?: string

            The description of the project category.

          • Optionalself?: string

            The URL of the project category.

        • OptionalprojectTypeKey?:
              | string & {}
              | "software"
              | "service_desk"
              | "business"
              | "product_discovery"
              | "customer_service"

          The project type of the project.

        • Optionalself?: string

          The URL of the project details.

        • Optionalsimplified?: boolean

          Whether or not the project is simplified.

      • Optionaltype?: string & {} | "PROJECT" | "TEMPLATE"

        The type of scope.

    • Optionalself?: string

      The URL of the permission scheme.

  • Optionalexpand?:
        | string
        | string[]
        | string & {}
        | (
            | "all"
            | "user"
            | "group"
            | "field"
            | string & {}
            | "permissions"
            | "projectRole"
        )[]

    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.

  • schemeId: number

    The ID of the permission scheme to update.

• Optionaloptions: RequestOptions