SoulFire TypeScript SDK 2.10.3
    Preparing search index...

    Type Alias UpdateUserRequest

    UpdateUserRequest: Message<"soulfire.v1.UpdateUserRequest"> & {
        email: string;
        id: string;
        role: UserRole;
        username: string;
    }

    Request message for updating an existing user's profile information. All fields except ID will be updated to the provided values.

    Type Declaration

    • email: string

      The new email address for the user. Must be a valid email format and unique across all users. Maximum length is 255 characters.

      from field: string email = 4;

    • id: string

      The unique identifier (UUID) of the user to update. Cannot be the ID of the requesting user (cannot update self via this method). Cannot be the root user ID (00000000-0000-0000-0000-000000000000).

      from field: string id = 1;

    • role: UserRole

      The new role to assign to the user. ADMIN users have all permissions, while USER role has limited permissions.

      from field: soulfire.v1.UserRole role = 3;

    • username: string

      The new username for the user. Must be lowercase, between 3 and 32 characters. Must begin with an alphanumeric character, followed by alphanumeric characters or dashes, and end with an alphanumeric character. Must be unique across all users.

      from field: string username = 2;

    from message soulfire.v1.UpdateUserRequest