Function getDirectoryUsers

getDirectoryUsers(
    client: Client,
    parameters: {
        accountIds?: string[];
        accountStatus?: ("active" | "inactive" | "closed" | string & {})[];
        claimStatus?: string & {} | "managed" | "unmanaged";
        cursor?: string;
        directoryId: string;
        directoryIds?: string[];
        emailDomains?: string[];
        groupIds?: string[];
        limit?: number;
        membershipStatus?: (
            "active"
            | "suspended"
            | string & {}
            | "no_membership"
        )[];
        mfaEnabled?: boolean;
        orgId: string;
        resourceIds?: string[];
        roleIds?: (
            | string & {}
            | "atlassian/org-admin"
            | "atlassian/site-admin"
            | "atlassian/user-access-admin"
            | "atlassian/ai-access"
            | "atlassian/user"
            | "atlassian/admin"
            | "atlassian/guest"
            | "atlassian/customer"
            | "atlassian/contributor"
            | "atlassian/basic"
            | "atlassian/stakeholder"
        )[];
        searchTerm?: string;
        status?: (
            | "active"
            | "suspended"
            | string & {}
            | "not_invited"
            | "deactivated"
            | "for_deletion"
        )[];
    },
    options?: RequestOptions,
): Promise<
    {
        data?: {
            accountId?: string;
            accountStatus?: "active"
            | "inactive"
            | "closed"
            | string & {};
            accountType?: string & {} | "atlassian";
            addedToOrg?: string;
            avatar?: string;
            claimStatus?: string & {} | "managed" | "unmanaged";
            counts?: { resources?: number; [key: string]: unknown };
            deactivatedOn?: string;
            department?: string | null;
            email?: string;
            emailVerified?: boolean;
            forDeletion?: boolean;
            groups?: {
                description?: string | null;
                id?: string;
                name?: string | null;
                [key: string]: unknown;
            }[];
            jobTitle?: string;
            links?: { self?: string
            | null; [key: string]: unknown };
            location?: string | null;
            managementSource?: string & {} | "synced" | "invited" | null;
            membershipStatus?: "active" | "suspended" | string & {} | "no_membership";
            mfaEnabled?: boolean;
            name?: string;
            nickname?: string;
            organization?: string | null;
            picture?: string;
            platformRoles?: (
                | string & {}
                | "atlassian/org-admin"
                | "atlassian/site-admin"
                | "atlassian/user-access-admin"
                | "atlassian/ai-access"
            )[];
            productAccess?: {
                id?: string;
                key?: string;
                lastActiveTimestamp?: Date;
                [key: string]: unknown;
            }[];
            status?: | "active"
            | "suspended"
            | string & {}
            | "not_invited"
            | "deactivated"
            | "for_deletion";
            timeZone?: string
            | null;
            [key: string]: unknown;
        }[];
        links?: {
            next?: string
            | null;
            prev?: string | null;
            self?: string | null;
            [key: string]: unknown;
        };
        [key: string]: unknown;
    },
>
This API is deprecated and will no longer work after June 30, 2027. Use the Search for users in an organization endpoint instead.

Return a page of users in your organization that match the supplied parameters. By default, returns users in all your directories.

To get users in a directory only, use the directoryIds field. To get your managed accounts, regardless if they’re in a directory or not, use the claimStatus field.

Scopes

Authorization scopes required: read:directories:admin
Parameters
- client: Client
- parameters: {
      accountIds?: string[];
      accountStatus?: ("active" | "inactive" | "closed" | string & {})[];
      claimStatus?: string & {} | "managed" | "unmanaged";
      cursor?: string;
      directoryId: string;
      directoryIds?: string[];
      emailDomains?: string[];
      groupIds?: string[];
      limit?: number;
      membershipStatus?: ("active" | "suspended" | string & {} | "no_membership")[];
      mfaEnabled?: boolean;
      orgId: string;
      resourceIds?: string[];
      roleIds?: (
          | string & {}
          | "atlassian/org-admin"
          | "atlassian/site-admin"
          | "atlassian/user-access-admin"
          | "atlassian/ai-access"
          | "atlassian/user"
          | "atlassian/admin"
          | "atlassian/guest"
          | "atlassian/customer"
          | "atlassian/contributor"
          | "atlassian/basic"
          | "atlassian/stakeholder"
      )[];
      searchTerm?: string;
      status?: (
          | "active"
          | "suspended"
          | string & {}
          | "not_invited"
          | "deactivated"
          | "for_deletion"
      )[];
  }
  - OptionalaccountIds?: string[]
    
    A list of user account IDs.
  - OptionalaccountStatus?: ("active" | "inactive" | "closed" | string & {})[]
    
    The lifecycle status of the account.
    
    active - The account is active and can be used.
    
    inactive - The account is inactive and doesn't have access to any resources.
    
    closed - The account is closed and can't be used.
  - OptionalclaimStatus?: string & {} | "managed" | "unmanaged"
    
    The claim status for the user account. By default, both managed and unmanaged accounts are returned.
    
    managed - Returns only managed accounts. For more on managed accounts: https://support.atlassian.com/user-management/docs/what-are-managed-accounts/
    
    unmanaged - Returns only unmanaged accounts.
  - Optionalcursor?: string
    
    Sets the cursor position to retrieve the next set of results. If present, all other parameters are discarded when searching.
  - directoryId: string
    
    Unique ID associated with a directory. The - character can be used to increase the operation scope to all directories the requestor has permission to manage.
  - OptionaldirectoryIds?: string[]
    
    A list of directory IDs. The requestor must have permissions to administer resources linked to these directories.
  - OptionalemailDomains?: string[]
    
    The email domain to filter the results. The email domain will be used to search against the account email domain. For example, get all users with the @atlassian.com or @example.com email domain.
  - OptionalgroupIds?: string[]
    
    A list of group IDs.
  - Optionallimit?: number
    
    The desired number of results for the search request.
  - OptionalmembershipStatus?: ("active" | "suspended" | string & {} | "no_membership")[]
    
    A list of membership statuses. The membership status is the status of the user account in the organization.
    
    active - the account has an active membership for one or more directories within the organization.
    
    suspended - the account is suspended in ALL directories within the organization, to which the requestor has permission to access.
    
    no_membership - the account is in NONE of the organization’s directories.
  - OptionalmfaEnabled?: boolean
    
    Whether or not a managed account has two-step verification enabled on their account. If true, they have two-step verification enabled. By default, all accounts are returned, regardless of two-step verification status.
  - orgId: string
    
    Your organization has a unique ID. Find this ID in your Atlassian Administration URL or when you create your API key.
  - OptionalresourceIds?: string[]
    
    A list of resource IDs. The resource IDs should be specified using the Atlassian Resource Identifier (ARI) format. Example ARI: ari:cloud:jira-core::site/1
  - OptionalroleIds?: (
        | string & {}
        | "atlassian/org-admin"
        | "atlassian/site-admin"
        | "atlassian/user-access-admin"
        | "atlassian/ai-access"
        | "atlassian/user"
        | "atlassian/admin"
        | "atlassian/guest"
        | "atlassian/customer"
        | "atlassian/contributor"
        | "atlassian/basic"
        | "atlassian/stakeholder"
    )[]
    
    A list of role IDs. The Atlassian canonical roles are used to determine the permissions of the user against resources within the organization. The allowed roles are:
    
    atlassian/user - Can access the product, with no product admin permissions
    
    atlassian/admin - Can access the product, with product admin permissions
    
    atlassian/guest - Can only access one space you or space admins specify
    
    atlassian/customer - (Jira Service Management) Can visit help center, submit help requests, and view articles (non-billable)
    
    atlassian/user-access-admin - No product access. Can administer users and groups for this product in Atlassian Administration
    
    atlassian/contributor - Can access the product to view, comment, and vote only (non-billable)
    
    atlassian/basic - Can access basic product features, with no product admin permissions (non-billable)
    
    atlassian/stakeholder - Can receive incident updates and has the same product access as Customer. Non-billable but available only on Premium and Enterprise plans
    
    atlassian/org-admin - An organization admin is the highest level of admin and can complete any administrative task in Atlassian Administration
    
    atlassian/site-admin - Site admins can access Atlassian Administration and complete tasks related to the specific site they are administering.
    
    atlassian/ai-access - Can use AI features in AI-enabled apps they have access to.
  - OptionalsearchTerm?: string
    
    A search term to search the nickname and email fields.
  - Optionalstatus?: (
        | "active"
        | "suspended"
        | string & {}
        | "not_invited"
        | "deactivated"
        | "for_deletion"
    )[]
    
    The status for the user account. This status is a composite of accountStatus and membershipStatus.
    
    active - accountStatus is active and membershipStatus is active.
    
    suspended - accountStatus is active and membershipStatus is suspended.
    
    not_invited - accountStatus is active and membershipStatus is no_membership.
    
    deactivated - accountStatus is inactive.
    
    for_deletion - Indicates whether or not a managed account is scheduled for deletion.
- Optionaloptions: RequestOptions
Returns Promise<
    {
        data?: {
            accountId?: string;
            accountStatus?: "active"
            | "inactive"
            | "closed"
            | string & {};
            accountType?: string & {} | "atlassian";
            addedToOrg?: string;
            avatar?: string;
            claimStatus?: string & {} | "managed" | "unmanaged";
            counts?: { resources?: number; [key: string]: unknown };
            deactivatedOn?: string;
            department?: string | null;
            email?: string;
            emailVerified?: boolean;
            forDeletion?: boolean;
            groups?: {
                description?: string | null;
                id?: string;
                name?: string | null;
                [key: string]: unknown;
            }[];
            jobTitle?: string;
            links?: { self?: string
            | null; [key: string]: unknown };
            location?: string | null;
            managementSource?: string & {} | "synced" | "invited" | null;
            membershipStatus?: "active" | "suspended" | string & {} | "no_membership";
            mfaEnabled?: boolean;
            name?: string;
            nickname?: string;
            organization?: string | null;
            picture?: string;
            platformRoles?: (
                | string & {}
                | "atlassian/org-admin"
                | "atlassian/site-admin"
                | "atlassian/user-access-admin"
                | "atlassian/ai-access"
            )[];
            productAccess?: {
                id?: string;
                key?: string;
                lastActiveTimestamp?: Date;
                [key: string]: unknown;
            }[];
            status?: | "active"
            | "suspended"
            | string & {}
            | "not_invited"
            | "deactivated"
            | "for_deletion";
            timeZone?: string
            | null;
            [key: string]: unknown;
        }[];
        links?: {
            next?: string
            | null;
            prev?: string | null;
            self?: string | null;
            [key: string]: unknown;
        };
        [key: string]: unknown;
    },
>

Deprecated
This API is deprecated and will no longer work after June 30, 2027. Use the Search for users in an organization endpoint instead.
- Defined in src/admin/api/users.ts:434

Function getDirectoryUsers

Scopes

Parameters

`Optional`accountIds?: string[]

`Optional`accountStatus?: ("active" | "inactive" | "closed" | string & {})[]

`Optional`claimStatus?: string & {} | "managed" | "unmanaged"

`Optional`cursor?: string

directoryId: string

`Optional`directoryIds?: string[]

`Optional`emailDomains?: string[]

`Optional`groupIds?: string[]

`Optional`limit?: number

`Optional`membershipStatus?: ("active" | "suspended" | string & {} | "no_membership")[]

`Optional`mfaEnabled?: boolean

orgId: string

`Optional`resourceIds?: string[]

`Optional`searchTerm?: string

`Optional`status?: (
    | "active"
    | "suspended"
    | string & {}
    | "not_invited"
    | "deactivated"
    | "for_deletion"
)[]

Deprecated

Settings

On This Page

Function getDirectoryUsers

Scopes

Parameters

OptionalaccountIds?: string[]

OptionalaccountStatus?: ("active" | "inactive" | "closed" | string & {})[]

OptionalclaimStatus?: string & {} | "managed" | "unmanaged"

Optionalcursor?: string

directoryId: string

OptionaldirectoryIds?: string[]

OptionalemailDomains?: string[]

OptionalgroupIds?: string[]

Optionallimit?: number

OptionalmembershipStatus?: ("active" | "suspended" | string & {} | "no_membership")[]

OptionalmfaEnabled?: boolean

orgId: string

OptionalresourceIds?: string[]

OptionalroleIds?: ( | string & {} | "atlassian/org-admin" | "atlassian/site-admin" | "atlassian/user-access-admin" | "atlassian/ai-access" | "atlassian/user" | "atlassian/admin" | "atlassian/guest" | "atlassian/customer" | "atlassian/contributor" | "atlassian/basic" | "atlassian/stakeholder")[]

OptionalsearchTerm?: string

Optionalstatus?: ( | "active" | "suspended" | string & {} | "not_invited" | "deactivated" | "for_deletion")[]

Deprecated

Settings

On This Page

`Optional`accountIds?: string[]

`Optional`accountStatus?: ("active" | "inactive" | "closed" | string & {})[]

`Optional`claimStatus?: string & {} | "managed" | "unmanaged"

`Optional`cursor?: string

`Optional`directoryIds?: string[]

`Optional`emailDomains?: string[]

`Optional`groupIds?: string[]

`Optional`limit?: number

`Optional`membershipStatus?: ("active" | "suspended" | string & {} | "no_membership")[]

`Optional`mfaEnabled?: boolean

`Optional`resourceIds?: string[]

`Optional`roleIds?: (
| string & {}
| "atlassian/org-admin"
| "atlassian/site-admin"
| "atlassian/user-access-admin"
| "atlassian/ai-access"
| "atlassian/user"
| "atlassian/admin"
| "atlassian/guest"
| "atlassian/customer"
| "atlassian/contributor"
| "atlassian/basic"
| "atlassian/stakeholder"
)[]

`Optional`searchTerm?: string

`Optional`status?: (
| "active"
| "suspended"
| string & {}
| "not_invited"
| "deactivated"
| "for_deletion"
)[]