Function: getDomains()

function getDomains(
   client, 
   parameters, 
   options?
): Promise<{
[key: string]: unknown;
  data?: object[];
  links?: {
   [key: string]: unknown;
     next?: string | null;
     prev?: string | null;
     self?: string | null;
  };
}>;

Defined in: src/admin/api/domains.ts:14

Returns a list of domains in an organization one page at a time.

Scopes

Authorization scopes required: read:domains:admin

Parameters

Parameter	Type	Description
client	Client	-
parameters	{ cursor?: string; orgId: 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.
options?	RequestOptions	-

Returns

Promise<{ [key: string]: unknown; data?: object[]; links?: { [key: string]: unknown; next?: string | null; prev?: string | null; self?: string | null; }; }>