Skip to content
Get started

Auth

Current user profile
client.auth.retrieveCurrentUser(RequestOptionsoptions?): AuthRetrieveCurrentUserResponse { id, email, email_verified }
GET/api/auth/me/
Register
client.auth.register(AuthRegisterParams { email, password, password_confirm } body, RequestOptionsoptions?): AuthRegisterResponse { access, refresh, user }
POST/api/auth/register/

AuthAPI Keys

List API tokens
client.auth.apiKeys.list(APIKeyListParams { ordering, page, search } query?, RequestOptionsoptions?): APIKeyListResponse { count, results, next, previous }
GET/api/auth/api-keys/
Generate API token
client.auth.apiKeys.create(APIKeyCreateParams { project, name } body, RequestOptionsoptions?): APIKeyCreateResponse { id, created_at, key, 2 more }
POST/api/auth/api-keys/
Revoke API token
client.auth.apiKeys.revoke(stringid, RequestOptionsoptions?): void
DELETE/api/auth/api-keys/{id}/

AuthToken

Create
client.auth.token.create(TokenCreateParams { email, password } body, RequestOptionsoptions?): TokenCreateResponse { access, refresh }
POST/api/auth/token/
Refresh
client.auth.token.refresh(TokenRefreshParams { refresh } body, RequestOptionsoptions?): TokenRefreshResponse { access, refresh }
POST/api/auth/token/refresh/