jira.js
    Preparing search index...

    Function getPermissionSchemeGrants

    • Returns all permission grants for 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 always included when you specify any value. Expand options include:

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

          The ID of the permission scheme.

      • Optionaloptions: RequestOptions

      Returns Promise<
          {
              expand?: string;
              permissions?: {
                  holder?: {
                      expand?: string;
                      parameter?: string;
                      type: string;
                      value?: string;
                      [key: string]: unknown;
                  };
                  id?: number;
                  permission?: string;
                  self?: string;
                  [key: string]: unknown;
              }[];
              [key: string]: unknown;
          },
      >