jira.js
    Preparing search index...

    Function getPolicies

    • Returns information about org policies

      Parameters

      • client: Client
      • parameters: { cursor?: string; orgId: string; type?: string }
        • Optionalcursor?: string

          Sets the starting point for the page of results to return.

        • orgId: string

          Your organization has a unique ID. Find this ID in your Atlassian Administration URL or when you create your API key.

        • Optionaltype?: string

          Sets the type for the page of policies to return.

      • Optionaloptions: RequestOptions

      Returns Promise<
          {
              data?: {
                  attributes: {
                      createdAt?: string;
                      id?: string;
                      metadata?: unknown;
                      name?: string;
                      ownerId?: string;
                      queryData?: unknown;
                      resources?: {
                          applicationStatus: | "failed"
                          | (...) & (...)
                          | "enabled"
                          | "applying"
                          | "removing"
                          | "applied"
                          | "scheduled";
                          createdAt?: string;
                          id: string;
                          links?: { ticket?: ...; [key: ...]: ... };
                          meta?: {
                              atlassianAccountId?: ...;
                              migrationEndDataTime?: ...;
                              migrationStartDateTime?: ...;
                              scheduledDate?: ...;
                              [key: ...]: ...;
                          };
                          metadata?: unknown;
                          type?: string;
                          updatedAt?: string;
                          [key: string]: unknown;
                      }[];
                      rule?: unknown[]
                      | { in?: string[]; [key: string]: unknown };
                      status?: "disabled" | string & {} | "enabled";
                      type:
                          | string & {}
                          | "ip-allowlist"
                          | "data-residency"
                          | "data-security"
                          | "admin-notification-settings"
                          | "generative-ai"
                          | "hipaa"
                          | "ugc-data-use-preferences"
                          | "user-join-settings-default";
                      updatedAt?: string;
                      [key: string]: unknown;
                  };
                  id: string;
                  links?: Record<string, any>;
                  message?: unknown;
                  type: string & {} | "policy";
                  [key: string]: unknown;
              }[];
              links?: {
                  next?: string
                  | null;
                  prev?: string | null;
                  self?: string | null;
                  [key: string]: unknown;
              };
              meta?: {
                  attributes?: unknown;
                  current?: number;
                  end_index?: number;
                  next?: string
                  | null;
                  page_size?: number;
                  prev?: string;
                  start_index?: number;
                  total?: number;
                  [key: string]: unknown;
              };
              [key: string]: unknown;
          },
      >