Function: getUser()

function getUser(
   client, 
   parameters?, 
   options?
): Promise<{
[key: string]: unknown;
  active?: boolean;
  applicationRoles?: {
   [key: string]: unknown;
     callback?: {
      [key: string]: unknown;
     };
     maxResults?: number;
     pagingCallback?: {
      [key: string]: unknown;
     };
     size?: number;
  };
  avatarUrls?: Record<string, string>;
  deleted?: boolean;
  displayName?: string;
  emailAddress?: string;
  expand?: string;
  groups?: {
   [key: string]: unknown;
     callback?: {
      [key: string]: unknown;
     };
     maxResults?: number;
     pagingCallback?: {
      [key: string]: unknown;
     };
     size?: number;
  };
  key?: string;
  lastLoginTime?: string;
  locale?: string;
  name?: string;
  self?: string;
  timeZone?: string;
}>;

Defined in: src/server/api/users.ts:52

Returns a user.

Parameters

Parameter	Type	Description
client	Client	-
parameters?	{ includeDeleted?: boolean; key?: string; username?: string; }	-
parameters.includeDeleted?	boolean	Whether deleted users should be returned (flag available to users with global ADMIN rights)
parameters.key?	string	User key
parameters.username?	string	The username
options?	RequestOptions	-

Returns

Promise<{ [key: string]: unknown; active?: boolean; applicationRoles?: { [key: string]: unknown; callback?: { [key: string]: unknown; }; maxResults?: number; pagingCallback?: { [key: string]: unknown; }; size?: number; }; avatarUrls?: Record<string, string>; deleted?: boolean; displayName?: string; emailAddress?: string; expand?: string; groups?: { [key: string]: unknown; callback?: { [key: string]: unknown; }; maxResults?: number; pagingCallback?: { [key: string]: unknown; }; size?: number; }; key?: string; lastLoginTime?: string; locale?: string; name?: string; self?: string; timeZone?: string; }>