Function: getPolicies()

function getPolicies(
   client, 
   parameters, 
   options?
): Promise<{
[key: string]: unknown;
  data?: object[];
  links?: {
   [key: string]: unknown;
     next?: string | null;
     prev?: string | null;
     self?: string | null;
  };
  meta?: {
   [key: string]: unknown;
     attributes?: unknown;
     current?: number;
     end_index?: number;
     next?: string | null;
     page_size?: number;
     prev?: string;
     start_index?: number;
     total?: number;
  };
}>;

Defined in: src/admin/api/policies.ts:15

Returns information about org policies

Parameters

Parameter	Type	Description
client	Client	-
parameters	{ cursor?: string; orgId: string; type?: string; }	-
parameters.cursor?	string	Sets the starting point for the page of results to return.
parameters.orgId?	string	Your organization has a unique ID. Find this ID in your Atlassian Administration URL or when you create your API key.
parameters.type?	string	Sets the type for the page of policies to return.
options?	RequestOptions	-

Returns

Promise<{ [key: string]: unknown; data?: object[]; links?: { [key: string]: unknown; next?: string | null; prev?: string | null; self?: string | null; }; meta?: { [key: string]: unknown; attributes?: unknown; current?: number; end_index?: number; next?: string | null; page_size?: number; prev?: string; start_index?: number; total?: number; }; }>