Type Alias UserAccountPatchBodyBody

UserAccountPatchBodyBody: {
    become_admin?: boolean;
    impersonate?: string;
    private?: boolean;
    use_impersonation?: boolean;
}

Optionalbecome_admin?: boolean
For admin accounts, if set the user account is able to read anything, i.e. GET API calls (i.e. endpoints that do not change the Data Manager state) behave as though the caller is acting as everyone. An admin user would set ths parameter in order to browse the system, and then switch to impersonate mode in order to change things as the chosen user
Optionalimpersonate?: string
For admin accounts, if set API calls behave as though the caller is the user being impersonated. To stop impersonating set this to an empty string. To set impersonation to anything other than an empty string you must also set become_admin

Max Length
80

Pattern
^(\w(?:\w*(?:[@.-]\w+)?)*|)$
Optionalprivate?: boolean
If set the user account becomes private, if provided but false the user account becomes public. Public Users show up in user searches
Optionaluse_impersonation?: boolean
For admin accounts, if this is set the account for the user being impersonated is patched, rather then the user's own account. To use this you must have a value for impersonate