Function: getDirectoriesForOrg()

function getDirectoriesForOrg(
   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/directory.ts:15

Returns a page of directories in an organization that match the supplied parameters.

Scopes

Authorization scopes required: read:directories:admin

Parameters

Parameter	Type	Description
client	Client	-
parameters	{ accountId?: string; cursor?: string; directoryIds?: string[]; limit?: number; orgId: string; searchTerm?: string; }	-
parameters.accountId?	string	Filters the results to only the directories where the specified user is a member.
parameters.cursor?	string	Sets the cursor position to retrieve the next set of results. If present, all other parameters are discarded when searching.
parameters.directoryIds?	string[]	A list of directory IDs. The requestor must have permissions to administer resources linked to these directories.
parameters.limit?	number	The desired number of results for the search request.
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.searchTerm?	string	A search term to search the name field.
options?	RequestOptions	-

Returns

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