jira.js
    Preparing search index...

    Function getPermissionScheme

    • Returns a permission scheme.

      Permissions required: Permission to access Jira.

      Parameters

      • client: Client
      • parameters: {
            expand?:
                | string
                | string[]
                | string & {}
                | (
                    | "all"
                    | "user"
                    | "group"
                    | "field"
                    | string & {}
                    | "permissions"
                    | "projectRole"
                )[];
            schemeId: number;
        }
        • 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 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 return.

      • Optionaloptions: RequestOptions

      Returns Promise<
          {
              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;
          },
      >

    Settings
    Member Visibility