Auth service

Auth

10 endpoints.

POST/api/v1/auth/forgot-password

Forgot Password

Parameters

Name	In	Type	Description
`X-Recaptcha-Token`	header	`string \| null`
`X-Recaptcha-Key-Type`	header	`string \| null`

Request bodyrequired

application/jsonForgotPasswordRequest

Field	Type	Description
`email`required	`string (email)`

Responses

200Successful Response

application/jsonany

422Validation Error

Error bodies: HTTPValidationError. See Errors.

POST/api/v1/auth/login

Login

OAuth2 compatible token login, get an access token for future requests.

Parameters

Name	In	Type	Description
`X-Recaptcha-Token`	header	`string \| null`
`X-Recaptcha-Key-Type`	header	`string \| null`

Request bodyrequired

application/x-www-form-urlencodedBody_login_api_v1_auth_login_post

Field	Type	Description
`grant_type`	`string \| null`
`username`required	`string`
`password`required	`string (password)`
`scope`	`string`	default ""
`client_id`	`string \| null`
`client_secret`	`string \| null`

Responses

200Successful Response

application/jsonToken

Token, expanded above.

422Validation Error

Error bodies: HTTPValidationError. See Errors.

POST/api/v1/auth/logout

Logout

Request bodyrequired

application/jsonLogoutRequest

Field	Type	Description
`refresh_token`required	`string`

Responses

200Successful Response

application/jsonany

422Validation Error

Error bodies: HTTPValidationError. See Errors.

POST/api/v1/auth/refresh

Refresh Token

Rotate refresh token.

Request bodyrequired

application/jsonRefreshTokenRequest

Field	Type	Description
`refresh_token`required	`string`

Responses

200Successful Response

application/jsonToken

Field	Type	Description
`access_token`required	`string`
`token_type`required	`string`
`refresh_token`required	`string`

422Validation Error

Error bodies: HTTPValidationError. See Errors.

POST/api/v1/auth/resend-verification

Resend Verification

Parameters

Name	In	Type	Description
`X-Recaptcha-Token`	header	`string \| null`
`X-Recaptcha-Key-Type`	header	`string \| null`

Request bodyrequired

application/jsonResendVerificationRequest

Field	Type	Description
`email`required	`string`

Responses

200Successful Response

application/jsonany

422Validation Error

Error bodies: HTTPValidationError. See Errors.

POST/api/v1/auth/reset-password

Reset Password

Parameters

Name	In	Type	Description
`X-Recaptcha-Token`	header	`string \| null`
`X-Recaptcha-Key-Type`	header	`string \| null`

Request bodyrequired

application/jsonResetPasswordRequest

Field	Type	Description
`token`	`string \| null`
`email`	`string (email) \| null`
`otp`	`string \| null`
`new_password`required	`string`

Responses

200Successful Response

application/jsonany

422Validation Error

Error bodies: HTTPValidationError. See Errors.

POST/api/v1/auth/signup

Create User

Create new user (201), or resend the code to a pending one (200).

Parameters

Name	In	Type	Description
`X-Recaptcha-Token`	header	`string \| null`
`X-Recaptcha-Key-Type`	header	`string \| null`

Request bodyrequired

application/jsonUserCreate

Field	Type	Description
`email`required	`string (email)`
`first_name`required	`string`
`last_name`required	`string`
`is_active`	`boolean \| null`	default true
`password`required	`string`
`invite_id`	`string \| null`

Responses

201Successful Response

application/jsonUserResponse

Field	Type	Description
`email`required	`string (email)`
`first_name`	`string \| null`
`last_name`	`string \| null`
`is_active`	`boolean \| null`	default true
`id`required	`string (uuid)`
`role_id`required	`integer`
`created_at`required	`string (date-time)`
`updated_at`required	`string (date-time)`
`avatar_url`	`string \| null`

422Validation Error

Error bodies: HTTPValidationError. See Errors.

POST/api/v1/auth/social

Social Login

Social Login (Google). Verifies ID Token, finds/creates user, issues JWTs.

Request bodyrequired

application/jsonSocialLoginRequest

Field	Type	Description
`provider`required	`string`
`token`required	`string`

Responses

200Successful Response

application/jsonToken

Token, expanded above.

422Validation Error

Error bodies: HTTPValidationError. See Errors.

GET/api/v1/auth/verify-email

Verify Email Token

Parameters

Name	In	Type	Description
`token`required	query	`string`

Responses

200Successful Response

application/jsonany

422Validation Error

Error bodies: HTTPValidationError. See Errors.

POST/api/v1/auth/verify-email

Verify Email Otp

Verify by the emailed six-digit code and sign the user in. 409 ALREADY_VERIFIED for a verified account, 401 ACCOUNT_INACTIVE for an inactive one, 400 INVALID_OTP otherwise.

Parameters

Name	In	Type	Description
`X-Recaptcha-Token`	header	`string \| null`
`X-Recaptcha-Key-Type`	header	`string \| null`

Request bodyrequired

application/jsonVerifyEmailOtpRequest

Field	Type	Description
`email`required	`string (email)`
`otp`required	`string`

Responses

200Successful Response

application/jsonToken

Token, expanded above.

422Validation Error

Error bodies: HTTPValidationError. See Errors.