SoulFire TypeScript SDK 2.10.3
    Preparing search index...

    Type Alias UserCreateRequest

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

    Request message for creating a new user account in the SoulFire system. The created user will have no password; authentication is done via JWT tokens.

    Type Declaration

    • email: string

      The 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 = 3;

    • role: UserRole

      The role to assign to the user. Determines what permissions the user has. ADMIN users have all permissions, while USER role has limited permissions controlled by server settings.

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

    • username: string

      The username for the new 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 = 1;

    from message soulfire.v1.UserCreateRequest