Function: updateProfile()
ts
function updateProfile(
client,
parameters,
options?
): Promise<{
[key: string]: unknown;
account: {
[key: string]: unknown;
account_id: string;
account_status: "active" | "inactive" | "closed" | string & object;
account_type: string & object | "atlassian" | "app" | "customer";
characteristics?: {
[key: string]: unknown;
not_mentionable?: boolean;
};
email: string;
extended_profile?: {
[key: string]: unknown;
department?: string;
job_title?: string;
location?: string;
organization?: string;
};
locale?: string;
name: string;
nickname: string;
picture: string;
zoneinfo?: string;
};
}>;Defined in: src/userManagement/api/profile.ts:24
Updates fields in a user account. The profile.write privilege details which fields you can change.
Parameters
| Parameter | Type | Description |
|---|---|---|
client | Client | - |
parameters | { accountId: string; extended_profile?: { department?: string; job_title?: string; location?: string; organization?: string; }; locale?: string; name?: string; nickname?: string; zoneinfo?: string; } | - |
parameters.accountId | string | The ID of the user to update |
parameters.extended_profile? | { department?: string; job_title?: string; location?: string; organization?: string; } | - |
parameters.extended_profile.department? | string | - |
parameters.extended_profile.job_title? | string | - |
parameters.extended_profile.location? | string | - |
parameters.extended_profile.organization? | string | - |
parameters.locale? | string | - |
parameters.name? | string | - |
parameters.nickname? | string | - |
parameters.zoneinfo? | string | - |
options? | RequestOptions | - |
Returns
Promise<{ [key: string]: unknown; account: { [key: string]: unknown; account_id: string; account_status: "active" | "inactive" | "closed" | string & object; account_type: string & object | "atlassian" | "app" | "customer"; characteristics?: { [key: string]: unknown; not_mentionable?: boolean; }; email: string; extended_profile?: { [key: string]: unknown; department?: string; job_title?: string; location?: string; organization?: string; }; locale?: string; name: string; nickname: string; picture: string; zoneinfo?: string; }; }>