Skip to content

Function: getDirectoryUserDetails() ​

ts
function getDirectoryUserDetails(
   client, 
   parameters, 
   options?
): Promise<{
[key: string]: unknown;
  data?: {
   [key: string]: unknown;
     accountId?: string;
     accountStatus?: "active" | "inactive" | "closed" | string & object;
     accountType?: string & object | "atlassian";
     addedToOrg?: string;
     avatar?: string;
     claimStatus?: string & object | "managed" | "unmanaged";
     counts?: {
      [key: string]: unknown;
        resources?: number;
     };
     deactivatedOn?: string | null;
     department?: string | null;
     email?: string;
     emailVerified?: boolean;
     forDeletion?: boolean;
     jobTitle?: string;
     links?: Record<string, any>;
     location?: string | null;
     managementSource?: string & object | "synced" | "invited" | null;
     membershipStatus?: "active" | "suspended" | string & object | "no_membership";
     mfaEnabled?: boolean;
     name?: string;
     nickname?: string;
     organization?: string | null;
     picture?: string;
     platformRoles?: (
        | string & object
        | "atlassian/org-admin"
        | "atlassian/site-admin"
        | "atlassian/user-access-admin"
       | "atlassian/ai-access")[];
     status?:   | "active"
        | "suspended"
        | string & object
        | "not_invited"
        | "deactivated"
        | "for_deletion";
     timeZone?: string | null;
  };
}>;

Defined in: src/admin/api/users.ts:241

Returns detailed information about a specific user in a directory within an organization.

Parameters ​

ParameterTypeDescription
clientClient-
parameters{ accountId: string; directoryId: string; orgId: string; }-
parameters.accountIdstringUnique ID associated with a user account.
parameters.directoryId?stringUnique ID associated with a directory. The - character can be used to increase the operation scope to all directories the requestor has permission to manage.
parameters.orgId?stringYour 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?: { [key: string]: unknown; accountId?: string; accountStatus?: "active" | "inactive" | "closed" | string & object; accountType?: string & object | "atlassian"; addedToOrg?: string; avatar?: string; claimStatus?: string & object | "managed" | "unmanaged"; counts?: { [key: string]: unknown; resources?: number; }; deactivatedOn?: string | null; department?: string | null; email?: string; emailVerified?: boolean; forDeletion?: boolean; jobTitle?: string; links?: Record<string, any>; location?: string | null; managementSource?: string & object | "synced" | "invited" | null; membershipStatus?: "active" | "suspended" | string & object | "no_membership"; mfaEnabled?: boolean; name?: string; nickname?: string; organization?: string | null; picture?: string; platformRoles?: ( | string & object | "atlassian/org-admin" | "atlassian/site-admin" | "atlassian/user-access-admin" | "atlassian/ai-access")[]; status?: | "active" | "suspended" | string & object | "not_invited" | "deactivated" | "for_deletion"; timeZone?: string | null; }; }>