jira.js
    Preparing search index...

    Function updatePermissionScheme

    • Updates a permission scheme. If the permissions list is present then it will be set in the permission scheme, which basically means it will overwrite any permission grants that existed in the permission scheme. Sending an empty list will remove all permission grants from the permission scheme. To update just the name and description, do not send permissions list at all. To add or remove a single permission grant instead of updating the whole list at once use the {schemeId}/permission/ resource.

      Parameters

      • client: Client
      • parameters: {
            body?: {
                description?: string;
                expand?: string;
                id?: number;
                name?: string;
                permissions?: {
                    holder?: {
                        expand?: string;
                        field?: {
                            clauseNames?: (...) | (...);
                            custom?: (...) | (...) | (...);
                            id?: (...) | (...);
                            name?: (...) | (...);
                            navigable?: (...) | (...) | (...);
                            orderable?: (...) | (...) | (...);
                            schema?: (...) | (...);
                            searchable?: (...) | (...) | (...);
                            [key: string]: unknown;
                        };
                        group?: {
                            name?: (...)
                            | (...);
                            self?: (...) | (...);
                            [key: string]: unknown;
                        };
                        parameter?: string;
                        projectRole?: {
                            actors?: (...)
                            | (...);
                            description?: (...) | (...);
                            id?: (...) | (...);
                            name?: (...) | (...);
                            self?: (...) | (...);
                            [key: string]: unknown;
                        };
                        type?: string;
                        user?: {
                            active?: (...)
                            | (...)
                            | (...);
                            avatarUrls?: (...) | (...);
                            displayName?: (...) | (...);
                            emailAddress?: (...) | (...);
                            key?: (...) | (...);
                            name?: (...) | (...);
                            self?: (...) | (...);
                            timeZone?: (...) | (...);
                            [key: string]: unknown;
                        };
                        [key: string]: unknown;
                    };
                    id?: number;
                    permission?: string;
                    self?: string;
                    [key: string]: unknown;
                }[];
                self?: string;
                [key: string]: unknown;
            };
            expand?: string
            | string[];
            schemeId: number;
        }
        • Optionalbody?: {
              description?: string;
              expand?: string;
              id?: number;
              name?: string;
              permissions?: {
                  holder?: {
                      expand?: string;
                      field?: {
                          clauseNames?: (...) | (...);
                          custom?: (...) | (...) | (...);
                          id?: (...) | (...);
                          name?: (...) | (...);
                          navigable?: (...) | (...) | (...);
                          orderable?: (...) | (...) | (...);
                          schema?: (...) | (...);
                          searchable?: (...) | (...) | (...);
                          [key: string]: unknown;
                      };
                      group?: {
                          name?: (...)
                          | (...);
                          self?: (...) | (...);
                          [key: string]: unknown;
                      };
                      parameter?: string;
                      projectRole?: {
                          actors?: (...)
                          | (...);
                          description?: (...) | (...);
                          id?: (...) | (...);
                          name?: (...) | (...);
                          self?: (...) | (...);
                          [key: string]: unknown;
                      };
                      type?: string;
                      user?: {
                          active?: (...)
                          | (...)
                          | (...);
                          avatarUrls?: (...) | (...);
                          displayName?: (...) | (...);
                          emailAddress?: (...) | (...);
                          key?: (...) | (...);
                          name?: (...) | (...);
                          self?: (...) | (...);
                          timeZone?: (...) | (...);
                          [key: string]: unknown;
                      };
                      [key: string]: unknown;
                  };
                  id?: number;
                  permission?: string;
                  self?: string;
                  [key: string]: unknown;
              }[];
              self?: string;
              [key: string]: unknown;
          }
        • Optionalexpand?: string | string[]

          Use expand to include full beans in the response. This parameter accepts a comma-separated list of expandable elements. Use 'permissions' to include permissions in the response.

        • schemeId: number

          The id of the permission scheme.

      • Optionaloptions: RequestOptions

      Returns Promise<
          {
              description?: string;
              expand?: string;
              id?: number;
              name?: string;
              permissions?: {
                  holder?: {
                      expand?: string;
                      field?: {
                          clauseNames?: (...)[];
                          custom?: boolean;
                          id?: string;
                          name?: string;
                          navigable?: boolean;
                          orderable?: boolean;
                          schema?: {
                              custom?: ...;
                              customId?: ...;
                              items?: ...;
                              system?: ...;
                              type?: ...;
                              [key: ...]: ...;
                          };
                          searchable?: boolean;
                          [key: string]: unknown;
                      };
                      group?: { name?: string; self?: string; [key: string]: unknown };
                      parameter?: string;
                      projectRole?: {
                          actors?: (...)[];
                          description?: string;
                          id?: number;
                          name?: string;
                          self?: string;
                          [key: string]: unknown;
                      };
                      type?: string;
                      user?: {
                          active?: boolean;
                          avatarUrls?: Record<(...), (...)>;
                          displayName?: string;
                          emailAddress?: string;
                          key?: string;
                          name?: string;
                          self?: string;
                          timeZone?: string;
                          [key: string]: unknown;
                      };
                      [key: string]: unknown;
                  };
                  id?: number;
                  permission?: string;
                  self?: string;
                  [key: string]: unknown;
              }[];
              self?: string;
              [key: string]: unknown;
          },
      >

    Settings
    Member Visibility