Function getDirectoriesForOrg

getDirectoriesForOrg(
    client: Client,
    parameters: {
        accountId?: string;
        cursor?: string;
        directoryIds?: string[];
        limit?: number;
        orgId: string;
        searchTerm?: string;
    },
    options?: RequestOptions,
): Promise<
    {
        data?: {
            directoryId?: string;
            icon?: string;
            name?: string;
            [key: string]: unknown;
        }[];
        links?: {
            next?: string
            | null;
            prev?: string | null;
            self?: string | null;
            [key: string]: unknown;
        };
        [key: string]: unknown;
    },
>
Returns a page of directories in an organization that match the supplied parameters.

Scopes

Authorization scopes required: read:directories:admin
Parameters
- client: Client
- parameters: {
      accountId?: string;
      cursor?: string;
      directoryIds?: string[];
      limit?: number;
      orgId: string;
      searchTerm?: string;
  }
  - OptionalaccountId?: string
    
    Filters the results to only the directories where the specified user is a member.
  - Optionalcursor?: string
    
    Sets the cursor position to retrieve the next set of results. If present, all other parameters are discarded when searching.
  - OptionaldirectoryIds?: string[]
    
    A list of directory IDs. The requestor must have permissions to administer resources linked to these directories.
  - Optionallimit?: number
    
    The desired number of results for the search request.
  - orgId: string
    
    Your organization has a unique ID. Find this ID in your Atlassian Administration URL or when you create your API key.
  - OptionalsearchTerm?: string
    
    A search term to search the name field.
- Optionaloptions: RequestOptions
Returns Promise<
    {
        data?: {
            directoryId?: string;
            icon?: string;
            name?: string;
            [key: string]: unknown;
        }[];
        links?: {
            next?: string
            | null;
            prev?: string | null;
            self?: string | null;
            [key: string]: unknown;
        };
        [key: string]: unknown;
    },
>
- Defined in src/admin/api/directory.ts:15

Function getDirectoriesForOrg

Scopes

Parameters

`Optional`accountId?: string

`Optional`cursor?: string

`Optional`directoryIds?: string[]

`Optional`limit?: number

orgId: string

`Optional`searchTerm?: string

Settings

On This Page

Function getDirectoriesForOrg

Scopes

Parameters

OptionalaccountId?: string

Optionalcursor?: string

OptionaldirectoryIds?: string[]

Optionallimit?: number

orgId: string

OptionalsearchTerm?: string

Returns Promise< { data?: { directoryId?: string; icon?: string; name?: string; [key: string]: unknown; }[]; links?: { next?: string | null; prev?: string | null; self?: string | null; [key: string]: unknown; }; [key: string]: unknown; },>

Settings

On This Page

`Optional`accountId?: string

`Optional`cursor?: string

`Optional`directoryIds?: string[]

`Optional`limit?: number

`Optional`searchTerm?: string

Returns Promise<
{
data?: {
directoryId?: string;
icon?: string;
name?: string;
[key: string]: unknown;
}[];
links?: {
next?: string
| null;
prev?: string | null;
self?: string | null;
[key: string]: unknown;
};
[key: string]: unknown;
},
>