Interface UpdateUserOptions
interface UpdateUserOptions {
name?: string;
email?: string;
roles?: Iterable<string, any, any>;
timeout?: number;
}
name?: string;
email?: string;
roles?: Iterable<string, any, any>;
timeout?: number;
}
Hierarchy (View Summary)
- TimeoutOptions
- UpdateUserOptions
Properties
Optionalname
name?: string
The new name.
Optionalemail
email?: string
The new email address.
Optionalroles
roles?: Iterable<string, any, any>
The roles to replace the user's with. At least one: to leave them as they are, leave this out.
Optionaltimeout
timeout?: number
Seconds to wait for this call. Defaults to the client's own timeout.
What UserOperations.update changes.
Only what is given changes. A field left out stays as it is; an empty name or email is sent, and clears it. The external id itself cannot be changed.