SAF Documentation

Appearance

@saflib/identity-spec

Interface: paths ​

This file was auto-generated by openapi-typescript. Do not make direct changes to the file.

Properties ​

/auth/forgot-password ​

/auth/forgot-password: object

delete? ​

optional delete: undefined

get? ​

optional get: undefined

optional head: undefined

options? ​

optional options: undefined

parameters ​

parameters: object

optional cookie: undefined

parameters.header? ​

optional header: undefined

parameters.path? ​

optional path: undefined

parameters.query? ​

optional query: undefined

patch? ​

optional patch: undefined

post ​

post: object

Request Password Reset

post.parameters ​

parameters: object

post.parameters.cookie? ​

optional cookie: undefined

post.parameters.header? ​

optional header: undefined

post.parameters.path? ​

optional path: undefined

post.parameters.query? ​

optional query: undefined

post.requestBody ​

requestBody: object

post.requestBody.content ​

content: object

post.requestBody.content.application/json ​

application/json: object

post.requestBody.content.application/json.email ​

email: string

Format: email

post.responses ​

responses: object

post.responses.200 ​

200: object

Description ​

If the user exists, a recovery email was sent

post.responses.200.content ​

content: object

post.responses.200.content.application/json ​

application/json: object

post.responses.200.content.application/json.message ​

message: string

Description ​

A generic message indicating that if the user exists, a recovery email was sent

post.responses.200.content.application/json.success ​

success: boolean

post.responses.200.headers ​

headers: object

Index Signature ​

[name: string]: unknown

post.responses.400 ​

400: object

Description ​

Invalid email format

post.responses.400.content ​

content: object

post.responses.400.content.application/json ​

application/json: object

post.responses.400.content.application/json.code? ​

optional code: string

Description ​

A short, machine-readable error code, for when HTTP status codes are not sufficient.

post.responses.400.content.application/json.message? ​

optional message: string

Description ​

A human-readable description of the error.

Example ​
ts
The requested resource could not be found.
post.responses.400.headers ​

headers: object

Index Signature ​

[name: string]: unknown

put? ​

optional put: undefined

trace? ​

optional trace: undefined

/auth/login ​

/auth/login: object

delete? ​

optional delete: undefined

get? ​

optional get: undefined

head? ​

optional head: undefined

options? ​

optional options: undefined

parameters ​

parameters: object

optional cookie: undefined

parameters.header? ​

optional header: undefined

parameters.path? ​

optional path: undefined

parameters.query? ​

optional query: undefined

patch? ​

optional patch: undefined

post ​

post: object

Authenticate User

post.parameters ​

parameters: object

post.parameters.cookie? ​

optional cookie: undefined

post.parameters.header? ​

optional header: undefined

post.parameters.path? ​

optional path: undefined

post.parameters.query? ​

optional query: undefined

post.requestBody ​

requestBody: object

post.requestBody.content ​

content: object

post.requestBody.content.application/json ​

application/json: object

post.requestBody.content.application/json.email ​

email: string

Format: email

post.requestBody.content.application/json.password ​

password: string

post.responses ​

responses: object

post.responses.200 ​

200: object

Description ​

Successful login

post.responses.200.content ​

content: object

post.responses.200.content.application/json ​

application/json: object

post.responses.200.content.application/json.createdAt? ​

optional createdAt: string

Format: date-time

Description ​

Date and time the user was created

post.responses.200.content.application/json.email? ​

optional email: string

Format: email

post.responses.200.content.application/json.emailVerified? ​

optional emailVerified: boolean

Description ​

Whether the user's email address has been verified

post.responses.200.content.application/json.familyName? ​

optional familyName: string

Description ​

User's family name (optional)

post.responses.200.content.application/json.givenName? ​

optional givenName: string

Description ​

User's given name (optional)

post.responses.200.content.application/json.id? ​

optional id: number

post.responses.200.content.application/json.lastLoginAt? ​

optional lastLoginAt: string

Format: date-time

Description ​

Date and time the user last logged in

post.responses.200.content.application/json.name? ​

optional name: string

Description ​

User's full name (optional)

post.responses.200.content.application/json.scopes? ​

optional scopes: string[]

Description ​

List of user's permission scopes

post.responses.200.content.application/json.verifiedAt? ​

optional verifiedAt: string

Format: date-time

Description ​

Date and time the user's email was verified

post.responses.200.headers ​

headers: object

Index Signature ​

[name: string]: unknown

post.responses.401 ​

401: object

Description ​

Invalid credentials

post.responses.401.content ​

content: object

post.responses.401.content.application/json ​

application/json: object

post.responses.401.content.application/json.code? ​

optional code: string

Description ​

A short, machine-readable error code, for when HTTP status codes are not sufficient.

post.responses.401.content.application/json.message? ​

optional message: string

Description ​

A human-readable description of the error.

Example ​
ts
The requested resource could not be found.
post.responses.401.headers ​

headers: object

Index Signature ​

[name: string]: unknown

put? ​

optional put: undefined

trace? ​

optional trace: undefined

/auth/logout ​

/auth/logout: object

delete? ​

optional delete: undefined

get? ​

optional get: undefined

head? ​

optional head: undefined

options? ​

optional options: undefined

parameters ​

parameters: object

optional cookie: undefined

parameters.header? ​

optional header: undefined

parameters.path? ​

optional path: undefined

parameters.query? ​

optional query: undefined

patch? ​

optional patch: undefined

post ​

post: object

Logout User

post.parameters ​

parameters: object

post.parameters.cookie? ​

optional cookie: undefined

post.parameters.header? ​

optional header: undefined

post.parameters.path? ​

optional path: undefined

post.parameters.query? ​

optional query: undefined

post.requestBody? ​

optional requestBody: undefined

post.responses ​

responses: object

post.responses.200 ​

200: object

Description ​

Successful logout

post.responses.200.content ​

content: object

post.responses.200.content.application/json ​

application/json: Record<string, never>

post.responses.200.headers ​

headers: object

Index Signature ​

[name: string]: unknown

put? ​

optional put: undefined

trace? ​

optional trace: undefined

/auth/profile ​

/auth/profile: object

delete? ​

optional delete: undefined

get ​

get: object

Get User Profile

Description ​

Get the profile information for the currently logged in user. Returns an empty object if the user is not authenticated.

get.parameters ​

parameters: object

optional cookie: undefined

get.parameters.header? ​

optional header: undefined

get.parameters.path? ​

optional path: undefined

get.parameters.query? ​

optional query: undefined

get.requestBody? ​

optional requestBody: undefined

get.responses ​

responses: object

get.responses.200 ​

200: object

Description ​

User profile retrieved successfully

get.responses.200.content ​

content: object

get.responses.200.content.application/json ​

application/json: object

get.responses.200.content.application/json.createdAt? ​

optional createdAt: string

Format: date-time

Description ​

Date and time the user was created

get.responses.200.content.application/json.email? ​

optional email: string

Format: email

get.responses.200.content.application/json.emailVerified? ​

optional emailVerified: boolean

Description ​

Whether the user's email address has been verified

get.responses.200.content.application/json.familyName? ​

optional familyName: string

Description ​

User's family name (optional)

get.responses.200.content.application/json.givenName? ​

optional givenName: string

Description ​

User's given name (optional)

get.responses.200.content.application/json.id? ​

optional id: number

get.responses.200.content.application/json.lastLoginAt? ​

optional lastLoginAt: string

Format: date-time

Description ​

Date and time the user last logged in

get.responses.200.content.application/json.name? ​

optional name: string

Description ​

User's full name (optional)

get.responses.200.content.application/json.scopes? ​

optional scopes: string[]

Description ​

List of user's permission scopes

get.responses.200.content.application/json.verifiedAt? ​

optional verifiedAt: string

Format: date-time

Description ​

Date and time the user's email was verified

get.responses.200.headers ​

headers: object

Index Signature ​

[name: string]: unknown

head? ​

optional head: undefined

options? ​

optional options: undefined

parameters ​

parameters: object

optional cookie: undefined

parameters.header? ​

optional header: undefined

parameters.path? ​

optional path: undefined

parameters.query? ​

optional query: undefined

patch? ​

optional patch: undefined

post? ​

optional post: undefined

put ​

put: object

Update User Profile

Description ​

Update the profile information for the currently logged in user

put.parameters ​

parameters: object

optional cookie: undefined

put.parameters.header? ​

optional header: undefined

put.parameters.path? ​

optional path: undefined

put.parameters.query? ​

optional query: undefined

put.requestBody ​

requestBody: object

put.requestBody.content ​

content: object

put.requestBody.content.application/json ​

application/json: object

put.requestBody.content.application/json.email? ​

optional email: string

Format: email

Description ​

User's email address

put.requestBody.content.application/json.emailVerified? ​

optional emailVerified: boolean

Description ​

Whether the user's email address has been verified

put.requestBody.content.application/json.familyName? ​

optional familyName: null | string

Description ​

User's family name (last name)

put.requestBody.content.application/json.givenName? ​

optional givenName: null | string

Description ​

User's given name (first name)

put.requestBody.content.application/json.name? ​

optional name: null | string

Description ​

User's full name

put.responses ​

responses: object

put.responses.200 ​

200: object

Description ​

User profile updated successfully

put.responses.200.content ​

content: object

put.responses.200.content.application/json ​

application/json: object

put.responses.200.content.application/json.createdAt? ​

optional createdAt: string

Format: date-time

Description ​

Date and time the user was created

put.responses.200.content.application/json.email? ​

optional email: string

Format: email

put.responses.200.content.application/json.emailVerified? ​

optional emailVerified: boolean

Description ​

Whether the user's email address has been verified

put.responses.200.content.application/json.familyName? ​

optional familyName: string

Description ​

User's family name (optional)

put.responses.200.content.application/json.givenName? ​

optional givenName: string

Description ​

User's given name (optional)

put.responses.200.content.application/json.id? ​

optional id: number

put.responses.200.content.application/json.lastLoginAt? ​

optional lastLoginAt: string

Format: date-time

Description ​

Date and time the user last logged in

put.responses.200.content.application/json.name? ​

optional name: string

Description ​

User's full name (optional)

put.responses.200.content.application/json.scopes? ​

optional scopes: string[]

Description ​

List of user's permission scopes

put.responses.200.content.application/json.verifiedAt? ​

optional verifiedAt: string

Format: date-time

Description ​

Date and time the user's email was verified

put.responses.200.headers ​

headers: object

Index Signature ​

[name: string]: unknown

put.responses.400 ​

400: object

Description ​

Invalid request data

put.responses.400.content ​

content: object

put.responses.400.content.application/json ​

application/json: object

put.responses.400.content.application/json.code? ​

optional code: string

Description ​

A short, machine-readable error code, for when HTTP status codes are not sufficient.

put.responses.400.content.application/json.message? ​

optional message: string

Description ​

A human-readable description of the error.

Example ​
ts
The requested resource could not be found.
put.responses.400.headers ​

headers: object

Index Signature ​

[name: string]: unknown

put.responses.401 ​

401: object

Description ​

User not authenticated

put.responses.401.content ​

content: object

put.responses.401.content.application/json ​

application/json: object

put.responses.401.content.application/json.code? ​

optional code: string

Description ​

A short, machine-readable error code, for when HTTP status codes are not sufficient.

put.responses.401.content.application/json.message? ​

optional message: string

Description ​

A human-readable description of the error.

Example ​
ts
The requested resource could not be found.
put.responses.401.headers ​

headers: object

Index Signature ​

[name: string]: unknown

put.responses.409 ​

409: object

Description ​

Email already exists (if trying to update email to one that's already taken)

put.responses.409.content ​

content: object

put.responses.409.content.application/json ​

application/json: object

put.responses.409.content.application/json.code? ​

optional code: string

Description ​

A short, machine-readable error code, for when HTTP status codes are not sufficient.

put.responses.409.content.application/json.message? ​

optional message: string

Description ​

A human-readable description of the error.

Example ​
ts
The requested resource could not be found.
put.responses.409.headers ​

headers: object

Index Signature ​

[name: string]: unknown

trace? ​

optional trace: undefined

/auth/register ​

/auth/register: object

delete? ​

optional delete: undefined

get? ​

optional get: undefined

head? ​

optional head: undefined

options? ​

optional options: undefined

parameters ​

parameters: object

optional cookie: undefined

parameters.header? ​

optional header: undefined

parameters.path? ​

optional path: undefined

parameters.query? ​

optional query: undefined

patch? ​

optional patch: undefined

post ​

post: object

Register New User

post.parameters ​

parameters: object

post.parameters.cookie? ​

optional cookie: undefined

post.parameters.header? ​

optional header: undefined

post.parameters.path? ​

optional path: undefined

post.parameters.query? ​

optional query: undefined

post.requestBody ​

requestBody: object

post.requestBody.content ​

content: object

post.requestBody.content.application/json ​

application/json: object

post.requestBody.content.application/json.email ​

email: string

Format: email

post.requestBody.content.application/json.familyName? ​

optional familyName: string

Description ​

User's family name (optional)

post.requestBody.content.application/json.givenName? ​

optional givenName: string

Description ​

User's given name (optional)

post.requestBody.content.application/json.name? ​

optional name: string

Description ​

User's full name (optional)

post.requestBody.content.application/json.password ​

password: string

post.responses ​

responses: object

post.responses.200 ​

200: object

Description ​

User registered successfully

post.responses.200.content ​

content: object

post.responses.200.content.application/json ​

application/json: object

post.responses.200.content.application/json.createdAt? ​

optional createdAt: string

Format: date-time

Description ​

Date and time the user was created

post.responses.200.content.application/json.email? ​

optional email: string

Format: email

post.responses.200.content.application/json.emailVerified? ​

optional emailVerified: boolean

Description ​

Whether the user's email address has been verified

post.responses.200.content.application/json.familyName? ​

optional familyName: string

Description ​

User's family name (optional)

post.responses.200.content.application/json.givenName? ​

optional givenName: string

Description ​

User's given name (optional)

post.responses.200.content.application/json.id? ​

optional id: number

post.responses.200.content.application/json.lastLoginAt? ​

optional lastLoginAt: string

Format: date-time

Description ​

Date and time the user last logged in

post.responses.200.content.application/json.name? ​

optional name: string

Description ​

User's full name (optional)

post.responses.200.content.application/json.scopes? ​

optional scopes: string[]

Description ​

List of user's permission scopes

post.responses.200.content.application/json.verifiedAt? ​

optional verifiedAt: string

Format: date-time

Description ​

Date and time the user's email was verified

post.responses.200.headers ​

headers: object

Index Signature ​

[name: string]: unknown

post.responses.409 ​

409: object

Description ​

Email already exists

post.responses.409.content ​

content: object

post.responses.409.content.application/json ​

application/json: object

post.responses.409.content.application/json.code? ​

optional code: string

Description ​

A short, machine-readable error code, for when HTTP status codes are not sufficient.

post.responses.409.content.application/json.message? ​

optional message: string

Description ​

A human-readable description of the error.

Example ​
ts
The requested resource could not be found.
post.responses.409.headers ​

headers: object

Index Signature ​

[name: string]: unknown

put? ​

optional put: undefined

trace? ​

optional trace: undefined

/auth/resend-verification ​

/auth/resend-verification: object

delete? ​

optional delete: undefined

get? ​

optional get: undefined

head? ​

optional head: undefined

options? ​

optional options: undefined

parameters ​

parameters: object

optional cookie: undefined

parameters.header? ​

optional header: undefined

parameters.path? ​

optional path: undefined

parameters.query? ​

optional query: undefined

patch? ​

optional patch: undefined

post ​

post: object

Resend Verification Email

post.parameters ​

parameters: object

post.parameters.cookie? ​

optional cookie: undefined

post.parameters.header? ​

optional header: undefined

post.parameters.path? ​

optional path: undefined

post.parameters.query? ​

optional query: undefined

post.requestBody? ​

optional requestBody: undefined

post.responses ​

responses: object

post.responses.200 ​

200: object

Description ​

Verification email sent successfully

post.responses.200.content ​

content: object

post.responses.200.content.application/json ​

application/json: object

post.responses.200.content.application/json.message ​

message: string

Description ​

A generic message indicating that the verification email was sent

post.responses.200.content.application/json.success ​

success: boolean

post.responses.200.headers ​

headers: object

Index Signature ​

[name: string]: unknown

post.responses.401 ​

401: object

Description ​

User not logged in

post.responses.401.content ​

content: object

post.responses.401.content.application/json ​

application/json: object

post.responses.401.content.application/json.code? ​

optional code: string

Description ​

A short, machine-readable error code, for when HTTP status codes are not sufficient.

post.responses.401.content.application/json.message? ​

optional message: string

Description ​

A human-readable description of the error.

Example ​
ts
The requested resource could not be found.
post.responses.401.headers ​

headers: object

Index Signature ​

[name: string]: unknown

put? ​

optional put: undefined

trace? ​

optional trace: undefined

/auth/reset-password ​

/auth/reset-password: object

delete? ​

optional delete: undefined

get? ​

optional get: undefined

head? ​

optional head: undefined

options? ​

optional options: undefined

parameters ​

parameters: object

optional cookie: undefined

parameters.header? ​

optional header: undefined

parameters.path? ​

optional path: undefined

parameters.query? ​

optional query: undefined

patch? ​

optional patch: undefined

post ​

post: object

Reset Password Using Token

post.parameters ​

parameters: object

post.parameters.cookie? ​

optional cookie: undefined

post.parameters.header? ​

optional header: undefined

post.parameters.path? ​

optional path: undefined

post.parameters.query? ​

optional query: undefined

post.requestBody ​

requestBody: object

post.requestBody.content ​

content: object

post.requestBody.content.application/json ​

application/json: object

post.requestBody.content.application/json.newPassword ​

newPassword: string

Description ​

The new password to set

post.requestBody.content.application/json.token ​

token: string

Description ​

The temporary password token received via email

post.responses ​

responses: object

post.responses.200 ​

200: object

Description ​

Password successfully reset

post.responses.200.content ​

content: object

post.responses.200.content.application/json ​

application/json: object

post.responses.200.content.application/json.success ​

success: boolean

post.responses.200.headers ​

headers: object

Index Signature ​

[name: string]: unknown

post.responses.400 ​

400: object

Description ​

Invalid token or password

post.responses.400.content ​

content: object

post.responses.400.content.application/json ​

application/json: object

post.responses.400.content.application/json.code? ​

optional code: string

Description ​

A short, machine-readable error code, for when HTTP status codes are not sufficient.

post.responses.400.content.application/json.message? ​

optional message: string

Description ​

A human-readable description of the error.

Example ​
ts
The requested resource could not be found.
post.responses.400.headers ​

headers: object

Index Signature ​

[name: string]: unknown

put? ​

optional put: undefined

trace? ​

optional trace: undefined

/auth/set-password ​

/auth/set-password: object

delete? ​

optional delete: undefined

get? ​

optional get: undefined

head? ​

optional head: undefined

options? ​

optional options: undefined

parameters ​

parameters: object

optional cookie: undefined

parameters.header? ​

optional header: undefined

parameters.path? ​

optional path: undefined

parameters.query? ​

optional query: undefined

patch? ​

optional patch: undefined

post ​

post: object

Change User Password

post.parameters ​

parameters: object

post.parameters.cookie? ​

optional cookie: undefined

post.parameters.header? ​

optional header: undefined

post.parameters.path? ​

optional path: undefined

post.parameters.query? ​

optional query: undefined

post.requestBody ​

requestBody: object

post.requestBody.content ​

content: object

post.requestBody.content.application/json ​

application/json: object

post.requestBody.content.application/json.currentPassword ​

currentPassword: string

Description ​

The user's current password for verification

post.requestBody.content.application/json.newPassword ​

newPassword: string

Description ​

The new password to set

post.responses ​

responses: object

post.responses.200 ​

200: object

Description ​

Password changed successfully

post.responses.200.content ​

content: object

post.responses.200.content.application/json ​

application/json: object

post.responses.200.content.application/json.success ​

success: boolean

post.responses.200.headers ​

headers: object

Index Signature ​

[name: string]: unknown

post.responses.401 ​

401: object

Description ​

User not logged in or invalid current password

post.responses.401.content ​

content: object

post.responses.401.content.application/json ​

application/json: object

post.responses.401.content.application/json.code? ​

optional code: string

Description ​

A short, machine-readable error code, for when HTTP status codes are not sufficient.

post.responses.401.content.application/json.message? ​

optional message: string

Description ​

A human-readable description of the error.

Example ​
ts
The requested resource could not be found.
post.responses.401.headers ​

headers: object

Index Signature ​

[name: string]: unknown

put? ​

optional put: undefined

trace? ​

optional trace: undefined

/auth/verify ​

/auth/verify: object

delete? ​

optional delete: undefined

get ​

get: object

Verify Authentication Status

Description ​

Used by Caddy for forward authentication. Verifies if the user is authenticated and adds user information headers for downstream services.

get.parameters ​

parameters: object

optional cookie: undefined

get.parameters.header? ​

optional header: undefined

get.parameters.path? ​

optional path: undefined

get.parameters.query? ​

optional query: undefined

get.requestBody? ​

optional requestBody: undefined

get.responses ​

responses: object

get.responses.200 ​

200: object

Description ​

User is authenticated

get.responses.200.content ​

content: object

get.responses.200.content.application/json ​

application/json: object

get.responses.200.content.application/json.createdAt? ​

optional createdAt: string

Format: date-time

Description ​

Date and time the user was created

get.responses.200.content.application/json.email? ​

optional email: string

Format: email

get.responses.200.content.application/json.emailVerified? ​

optional emailVerified: boolean

Description ​

Whether the user's email address has been verified

get.responses.200.content.application/json.familyName? ​

optional familyName: string

Description ​

User's family name (optional)

get.responses.200.content.application/json.givenName? ​

optional givenName: string

Description ​

User's given name (optional)

get.responses.200.content.application/json.id? ​

optional id: number

get.responses.200.content.application/json.lastLoginAt? ​

optional lastLoginAt: string

Format: date-time

Description ​

Date and time the user last logged in

get.responses.200.content.application/json.name? ​

optional name: string

Description ​

User's full name (optional)

get.responses.200.content.application/json.scopes? ​

optional scopes: string[]

Description ​

List of user's permission scopes

get.responses.200.content.application/json.verifiedAt? ​

optional verifiedAt: string

Format: date-time

Description ​

Date and time the user's email was verified

get.responses.200.headers ​

headers: object

Index Signature ​

[name: string]: unknown

get.responses.200.headers.X-User-Email? ​

optional X-User-Email: string

Description ​

The authenticated user's email

get.responses.200.headers.X-User-Email-Verified? ​

optional X-User-Email-Verified: "true" | "false"

Description ​

Whether the authenticated user's email is verified ('true' or 'false')

get.responses.200.headers.X-User-ID? ​

optional X-User-ID: string

Description ​

The authenticated user's ID

get.responses.200.headers.X-User-Scopes? ​

optional X-User-Scopes: string

Description ​

Comma-separated list of user's permission scopes

get.responses.401 ​

401: object

Description ​

User is not authenticated

get.responses.401.content ​

content: object

get.responses.401.content.application/json ​

application/json: object

get.responses.401.content.application/json.code? ​

optional code: string

Description ​

A short, machine-readable error code, for when HTTP status codes are not sufficient.

get.responses.401.content.application/json.message? ​

optional message: string

Description ​

A human-readable description of the error.

Example ​
ts
The requested resource could not be found.
get.responses.401.headers ​

headers: object

Index Signature ​

[name: string]: unknown

get.responses.403 ​

403: object

Description ​

CSRF token mismatch

get.responses.403.content ​

content: object

get.responses.403.content.application/json ​

application/json: object

get.responses.403.content.application/json.code? ​

optional code: string

Description ​

A short, machine-readable error code, for when HTTP status codes are not sufficient.

get.responses.403.content.application/json.message? ​

optional message: string

Description ​

A human-readable description of the error.

Example ​
ts
The requested resource could not be found.
get.responses.403.headers ​

headers: object

Index Signature ​

[name: string]: unknown

head? ​

optional head: undefined

options? ​

optional options: undefined

parameters ​

parameters: object

optional cookie: undefined

parameters.header? ​

optional header: undefined

parameters.path? ​

optional path: undefined

parameters.query? ​

optional query: undefined

patch? ​

optional patch: undefined

post? ​

optional post: undefined

put? ​

optional put: undefined

trace? ​

optional trace: undefined

/auth/verify-email ​

/auth/verify-email: object

delete? ​

optional delete: undefined

get? ​

optional get: undefined

head? ​

optional head: undefined

options? ​

optional options: undefined

parameters ​

parameters: object

optional cookie: undefined

parameters.header? ​

optional header: undefined

parameters.path? ​

optional path: undefined

parameters.query? ​

optional query: undefined

patch? ​

optional patch: undefined

post ​

post: object

Verify Email Address

post.parameters ​

parameters: object

post.parameters.cookie? ​

optional cookie: undefined

post.parameters.header? ​

optional header: undefined

post.parameters.path? ​

optional path: undefined

post.parameters.query? ​

optional query: undefined

post.requestBody ​

requestBody: object

post.requestBody.content ​

content: object

post.requestBody.content.application/json ​

application/json: object

post.requestBody.content.application/json.token ​

token: string

Description ​

The verification token sent in the email

post.responses ​

responses: object

post.responses.200 ​

200: object

Description ​

Email verified successfully

post.responses.200.content ​

content: object

post.responses.200.content.application/json ​

application/json: object

post.responses.200.content.application/json.createdAt? ​

optional createdAt: string

Format: date-time

Description ​

Date and time the user was created

post.responses.200.content.application/json.email? ​

optional email: string

Format: email

post.responses.200.content.application/json.emailVerified? ​

optional emailVerified: boolean

Description ​

Whether the user's email address has been verified

post.responses.200.content.application/json.familyName? ​

optional familyName: string

Description ​

User's family name (optional)

post.responses.200.content.application/json.givenName? ​

optional givenName: string

Description ​

User's given name (optional)

post.responses.200.content.application/json.id? ​

optional id: number

post.responses.200.content.application/json.lastLoginAt? ​

optional lastLoginAt: string

Format: date-time

Description ​

Date and time the user last logged in

post.responses.200.content.application/json.name? ​

optional name: string

Description ​

User's full name (optional)

post.responses.200.content.application/json.scopes? ​

optional scopes: string[]

Description ​

List of user's permission scopes

post.responses.200.content.application/json.verifiedAt? ​

optional verifiedAt: string

Format: date-time

Description ​

Date and time the user's email was verified

post.responses.200.headers ​

headers: object

Index Signature ​

[name: string]: unknown

post.responses.400 ​

400: object

Description ​

Invalid or expired token

post.responses.400.content ​

content: object

post.responses.400.content.application/json ​

application/json: object

post.responses.400.content.application/json.code? ​

optional code: string

Description ​

A short, machine-readable error code, for when HTTP status codes are not sufficient.

post.responses.400.content.application/json.message? ​

optional message: string

Description ​

A human-readable description of the error.

Example ​
ts
The requested resource could not be found.
post.responses.400.headers ​

headers: object

Index Signature ​

[name: string]: unknown

post.responses.401 ​

401: object

Description ​

User not logged in

post.responses.401.content ​

content: object

post.responses.401.content.application/json ​

application/json: object

post.responses.401.content.application/json.code? ​

optional code: string

Description ​

A short, machine-readable error code, for when HTTP status codes are not sufficient.

post.responses.401.content.application/json.message? ​

optional message: string

Description ​

A human-readable description of the error.

Example ​
ts
The requested resource could not be found.
post.responses.401.headers ​

headers: object

Index Signature ​

[name: string]: unknown

post.responses.403 ​

403: object

Description ​

User not authorized to verify email

post.responses.403.content ​

content: object

post.responses.403.content.application/json ​

application/json: object

post.responses.403.content.application/json.code? ​

optional code: string

Description ​

A short, machine-readable error code, for when HTTP status codes are not sufficient.

post.responses.403.content.application/json.message? ​

optional message: string

Description ​

A human-readable description of the error.

Example ​
ts
The requested resource could not be found.
post.responses.403.headers ​

headers: object

Index Signature ​

[name: string]: unknown

put? ​

optional put: undefined

trace? ​

optional trace: undefined

/users ​

/users: object

delete? ​

optional delete: undefined

get ​

get: object

List all users

get.parameters ​

parameters: object

optional cookie: undefined

get.parameters.header? ​

optional header: undefined

get.parameters.path? ​

optional path: undefined

get.parameters.query? ​

optional query: undefined

get.requestBody? ​

optional requestBody: undefined

get.responses ​

responses: object

get.responses.200 ​

200: object

Description ​

A list of user objects

get.responses.200.content ​

content: object

get.responses.200.content.application/json ​

application/json: object[]

get.responses.200.headers ​

headers: object

Index Signature ​

[name: string]: unknown

get.responses.401 ​

401: object

Description ​

Unauthorized - missing or invalid auth headers, or not logged in.

get.responses.401.content ​

content: object

get.responses.401.content.application/json ​

application/json: object

get.responses.401.content.application/json.code? ​

optional code: string

Description ​

A short, machine-readable error code, for when HTTP status codes are not sufficient.

get.responses.401.content.application/json.message? ​

optional message: string

Description ​

A human-readable description of the error.

Example ​
ts
The requested resource could not be found.
get.responses.401.headers ​

headers: object

Index Signature ​

[name: string]: unknown

get.responses.403 ​

403: object

Description ​

Forbidden - user does not have admin privileges.

get.responses.403.content ​

content: object

get.responses.403.content.application/json ​

application/json: object

get.responses.403.content.application/json.code? ​

optional code: string

Description ​

A short, machine-readable error code, for when HTTP status codes are not sufficient.

get.responses.403.content.application/json.message? ​

optional message: string

Description ​

A human-readable description of the error.

Example ​
ts
The requested resource could not be found.
get.responses.403.headers ​

headers: object

Index Signature ​

[name: string]: unknown

head? ​

optional head: undefined

options? ​

optional options: undefined

parameters ​

parameters: object

optional cookie: undefined

parameters.header? ​

optional header: undefined

parameters.path? ​

optional path: undefined

parameters.query? ​

optional query: undefined

patch? ​

optional patch: undefined

post? ​

optional post: undefined

put? ​

optional put: undefined

trace? ​

optional trace: undefined