Function updateUserById

updateUserById<ThrowOnError extends boolean = true>(
    options: Options<UpdateUserByIdData, ThrowOnError>,
): RequestResult<
    {
        data: {
            attributes: {
                createdAt: string;
                displayName: null
                | string;
                email: string;
                emailSignature: null | string;
                mobile: null | string;
                name: string;
                password: { allowNew: boolean; forceNew: boolean; updatedAt: string };
                roleGroups: string[];
                roles: string[];
                updatedAt: string;
                userType: string;
            };
            id: string;
            links: { self: string };
            relationships: {
                org: { data: { id: string; type: string }; links: { self: string } };
            };
            type: string;
        };
    },
    unknown,
    ThrowOnError,
>
Update User by ID Updates a specific user by ID.

Note
To delete a user, set deleted to true. You can un-delete by setting the deleted to null
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- options: Options<UpdateUserByIdData, ThrowOnError>
Returns RequestResult<
    {
        data: {
            attributes: {
                createdAt: string;
                displayName: null
                | string;
                email: string;
                emailSignature: null | string;
                mobile: null | string;
                name: string;
                password: { allowNew: boolean; forceNew: boolean; updatedAt: string };
                roleGroups: string[];
                roles: string[];
                updatedAt: string;
                userType: string;
            };
            id: string;
            links: { self: string };
            relationships: {
                org: { data: { id: string; type: string }; links: { self: string } };
            };
            type: string;
        };
    },
    unknown,
    ThrowOnError,
>
- Defined in src/api/sdk.gen.ts:5633

Function updateUserById

Note

Type Parameters

Parameters

Settings

On This Page