Authentication Emails

Upsert

post

Upsert an Authentication Email entry.

Creates a new Authentication Email if the provided id does not exist, or updates the existing Authentication Email with the given id.

Args: request (AuthenticationEmail): The Authentication Email data to insert or update. db (AsyncSession): The database session dependency.

Returns: JSONResponse: A JSON response containing the Authentication Email data that was upserted.

Raises: HTTPException: If the operation encounters an unexpected error (not currently implemented, but can be added for error handling).

Notes: - Uses FastCRUD for abstracted DB operations. - Relies on the id field to determine insert vs update.

Required scopes

This endpoint requires the following scopes:

• : Read Permissions

Authorizations

OAuth2PasswordBearer

OAuth2passwordRequired

Token URL:

Body

application/json

Authentication Email model.

idintegerRequired

patternstringRequired

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

post

/authentication-emails/upsert

HTTPcURLJavaScriptPython

POST /authentication-emails/upsert HTTP/1.1
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 25

{
  "id": 1,
  "pattern": "text"
}

No content

Get

get

Read multiple AuthenticationEmailModel rows from the database.

• Use page & itemsPerPage for paginated results

• Use offset & limit for specific ranges

• Returns paginated response when using page/itemsPerPage

• Returns simple list response when using offset/limit

Required scopes

This endpoint requires the following scopes:

• : Read Permissions

Authorizations

OAuth2PasswordBearer

OAuth2passwordRequired

Token URL:

Query parameters

offsetany ofOptional

Offset for unpaginated queries

integerOptional

or

nullOptional

limitany ofOptional

Limit for unpaginated queries

integerOptional

or

nullOptional

pageany ofOptional

Page number

integerOptional

or

nullOptional

itemsPerPageany ofOptional

Number of items per page

integerOptional

or

nullOptional

Responses

200

Successful Response

application/json

Responseany of

or

422

Validation Error

application/json

get

/authentication-emails

HTTPcURLJavaScriptPython

GET /authentication-emails HTTP/1.1
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "data": [
    {
      "id": 1,
      "pattern": "text"
    }
  ],
  "total_count": 1,
  "has_more": true,
  "page": 1,
  "items_per_page": 1
}

Create

post

Create a new AuthenticationEmailModel row in the database.

Required scopes

This endpoint requires the following scopes:

• : Read Permissions

Authorizations

OAuth2PasswordBearer

OAuth2passwordRequired

Token URL:

Body

application/json

Create Authentication Email model.

patternstringRequired

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

post

/authentication-emails

HTTPcURLJavaScriptPython

POST /authentication-emails HTTP/1.1
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 18

{
  "pattern": "text"
}

No content

Get

get

Read a single AuthenticationEmailModel row from the database by its primary keys: ['id'].

Required scopes

This endpoint requires the following scopes:

• : Read Permissions

Authorizations

OAuth2PasswordBearer

OAuth2passwordRequired

Token URL:

Path parameters

idintegerRequired

Responses

200

Successful Response

application/json

422

Validation Error

application/json

get

/authentication-emails/{id}

HTTPcURLJavaScriptPython

GET /authentication-emails/{id} HTTP/1.1
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "id": 1,
  "pattern": "text"
}

Delete

delete

Delete a AuthenticationEmailModel row from the database by its primary keys: ['id'].

Required scopes

This endpoint requires the following scopes:

• : Read Permissions

Authorizations

OAuth2PasswordBearer

OAuth2passwordRequired

Token URL:

Path parameters

idintegerRequired

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

delete

/authentication-emails/{id}

HTTPcURLJavaScriptPython

DELETE /authentication-emails/{id} HTTP/1.1
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

No content

Update

patch

Update an existing AuthenticationEmailModel row in the database by its primary keys: ['id'].

Required scopes

This endpoint requires the following scopes:

• : Read Permissions

Authorizations

OAuth2PasswordBearer

OAuth2passwordRequired

Token URL:

Path parameters

idintegerRequired

Body

application/json

Create Authentication Email model.

patternstringRequired

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

patch

/authentication-emails/{id}

HTTPcURLJavaScriptPython

PATCH /authentication-emails/{id} HTTP/1.1
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 18

{
  "pattern": "text"
}

No content