Function: getUser()

function getUser(
   client, 
   parameters, 
   options?
): Promise<{
[key: string]: unknown;
  active?: boolean;
  department?: string;
  displayName?: string;
  emails?: object[];
  externalId?: string;
  groups?: object[];
  id?: string;
  meta?: {
   [key: string]: unknown;
     created?: Date;
     lastModified?: Date;
     location?: string;
     resourceType?: string & object | "USER" | "GROUP" | "DIRECTORY";
  };
  name?: {
   [key: string]: unknown;
     familyName?: string;
     formatted?: string;
     givenName?: string;
     honorificPrefix?: string;
     honorificSuffix?: string;
     middleName?: string;
  };
  nickName?: string;
  organization?: string;
  phoneNumbers?: object[];
  preferredLanguage?: string;
  schemas?: string[];
  timezone?: string;
  title?: string;
  urn:ietf:params:scim:schemas:extension:enterprise:2.0:User?: {
   [key: string]: unknown;
     department?: string;
     organization?: string;
  };
  urn:scim:schemas:extension:atlassian-external:1.0?: {
   [key: string]: unknown;
     atlassianAccountId?: string;
  };
  userName?: string;
}>;

Defined in: src/userProvisioning/api/users.ts:12

Retrieves a user from the directory based on their userId.

Parameters

Parameter	Type	Description
client	Client	-
parameters	{ attributes?: string; directoryId: string; excludedAttributes?: string; userId: string; }	-
parameters.attributes?	string	Resource attributes to be included in response. Mutually exclusive with excludedAttributes. Example: userName,emails.value
parameters.directoryId?	string	The SCIM base URL that is generated when conecting an identity provider with SCIM provisioning.
parameters.excludedAttributes?	string	Resource attributes to be excluded from response. Mutually exclusive with attributes. Example: timezone,emails.type,department
parameters.userId?	string	Unique ID to identiy the users. Use the Get users API to get the userId.
options?	RequestOptions	-

Returns

Promise<{ [key: string]: unknown; active?: boolean; department?: string; displayName?: string; emails?: object[]; externalId?: string; groups?: object[]; id?: string; meta?: { [key: string]: unknown; created?: Date; lastModified?: Date; location?: string; resourceType?: string & object | "USER" | "GROUP" | "DIRECTORY"; }; name?: { [key: string]: unknown; familyName?: string; formatted?: string; givenName?: string; honorificPrefix?: string; honorificSuffix?: string; middleName?: string; }; nickName?: string; organization?: string; phoneNumbers?: object[]; preferredLanguage?: string; schemas?: string[]; timezone?: string; title?: string; urn:ietf:params:scim:schemas:extension:enterprise:2.0:User?: { [key: string]: unknown; department?: string; organization?: string; }; urn:scim:schemas:extension:atlassian-external:1.0?: { [key: string]: unknown; atlassianAccountId?: string; }; userName?: string; }>