Authentication

Create Client

post

Create a new client. This function creates a new client using the provided client name and master credentials. If the client is created successfully, it returns the client information. If the client creation fails, it raises an HTTPException with a 400 status code and an error message.

Args: request (CreateClientRequest): The request object containing the client name and master credentials.

Returns: Client: The created client information.

Raises: HTTPException: If the client creation fails, an HTTPException is raised with a 400 status code and an error message.

Body

application/x-www-form-urlencoded

usernamestringRequired

The Master Username.

passwordstringRequired

The Master Password.

client_namestringRequired

The name of the client.

Responses

200

Successful Response

application/json

422

Validation Error

application/json

post

/client

HTTPcURLJavaScriptPython

POST /client HTTP/1.1
Host: 
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 58

"username='text'&password='text'&client_name='text'"

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "api_key": "text",
  "is_active": true,
  "created_at": "2026-01-13T03:43:19.341Z"
}

Create User

post

Create a new user. This function creates a new user using the provided identifier and master credentials. If the user is created successfully, it returns the user information. If the user creation fails, it raises an HTTPException with a 400 status code and an error message.

Args: request (CreateUserRequest): The request object containing the user identifier and master credentials.

Returns: UserModel: The created user information.

Raises: HTTPException: If the user creation fails, an HTTPException is raised with a 400 status code and an error message.

Body

application/x-www-form-urlencoded

usernamestringRequired

The Master Username.

passwordstringRequired

The Master Password.

identifierstringRequired

The identifier for the user.

Responses

200

Successful Response

application/json

422

Validation Error

application/json

post

/user

HTTPcURLJavaScriptPython

POST /user HTTP/1.1
Host: 
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 57

"username='text'&password='text'&identifier='text'"

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "identifier": "text",
  "secret_preview": "text",
  "is_active": true,
  "client_id": "123e4567-e89b-12d3-a456-426614174000",
  "secret": "text"
}

Get Token

get

Get the current user with the token. This function retrieves the current user.

Args: user (User): The current user.

Returns: User: The current user with the token.

Authorizations

OAuth2PasswordBearer

OAuth2passwordRequired

Token URL:

Available scopes:

• : Read Permissions

Responses

200

Successful Response

application/json

get

/token

HTTPcURLJavaScriptPython

GET /token HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

200

Successful Response

{
  "user_id": "text",
  "username": "text",
  "scopes": [
    "text"
  ]
}

Create Token

post

Create a new token. This function creates a new token using the provided identifier and secret. If the token is created successfully, it returns the token information. If the token creation fails, it raises an HTTPException with a 400 status code and an error message.

Args: request (CreateTokenRequest): The request object containing the user identifier and secret.

Returns: TokenComplete: The created token information.

Raises: HTTPException: If the token creation fails, an HTTPException is raised with a 400 status code and an error message.

Body

application/x-www-form-urlencoded

identifierstringRequired

The identifier for the token. It can be a user ID, email, or any unique identifier.

secretstringRequired

The secret for the token. It can be a password, API key, or any secret value.

Responses

200

Successful Response

application/json

422

Validation Error

application/json

post

/token

HTTPcURLJavaScriptPython

POST /token HTTP/1.1
Host: 
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 37

"identifier='text'&secret='text'"

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "token": "text",
  "token_type": "text",
  "expires_at": "2026-01-13T03:43:19.341Z",
  "is_revoked": true,
  "user_id": "123e4567-e89b-12d3-a456-426614174000",
  "client_id": "123e4567-e89b-12d3-a456-426614174000"
}