Skip to content
Overmind
Get started
API Reference
Auth

Register

auth.register(AuthRegisterParams**kwargs) -> AuthRegisterResponse
POST/api/auth/register/

Create an account with email and password.

ParametersExpand Collapse
email: str
formatemail
minLength1
password: str
minLength8
maxLength128
password_confirm: str
minLength8
maxLength128
ReturnsExpand Collapse
class AuthRegisterResponse: …
access: str
refresh: str
user: User
id: int
email: str
formatemail
maxLength254
email_verified: Optional[bool]
Register
from overmind_lab import OvermindLab

client = OvermindLab()
response = client.auth.register(
    email="dev@stainless.com",
    password="xxxxxxxx",
    password_confirm="xxxxxxxx",
)
print(response.access)
{
  "access": "access",
  "refresh": "refresh",
  "user": {
    "id": 0,
    "email": "dev@stainless.com",
    "email_verified": true
  }
}
Returns Examples
{
  "access": "access",
  "refresh": "refresh",
  "user": {
    "id": 0,
    "email": "dev@stainless.com",
    "email_verified": true
  }
}