Skip to content

Auth Keys

auth_keys_add_user async 

auth_keys_add_user(auth: Annotated[Auth, Depends(authorize(HYBRID))], db: Annotated[Session, Depends(get_db)], user_id: Annotated[int, Path(alias=userId)], body: AddAuthKeyBody) -> AddAuthKeyResponse

Create an AuthKey for a specific user and save it in the database.

args:

  • the user’s authentification status

  • the current database

  • the id of the user

  • the request body

returns:

  • the added authkey

auth_keys_add_user_depr async 

auth_keys_add_user_depr(auth: Annotated[Auth, Depends(authorize(HYBRID))], db: Annotated[Session, Depends(get_db)], user_id: Annotated[int, Path(alias=userId)], body: AddAuthKeyBody) -> AddAuthKeyResponse

Create an AuthKey for a specific user and write it to the database.

args:

  • the user’s authentification status

  • the current database

  • the id of the user

  • the request body

returns:

  • the added authkey

auth_keys_delete_auth_key async 

auth_keys_delete_auth_key(auth: Annotated[Auth, Depends(authorize(HYBRID))], db: Annotated[Session, Depends(get_db)], auth_key_id: Annotated[int, Path(alias=AuthKeyId)]) -> StandardStatusIdentifiedResponse

Delete AuthKey by AuthKeyId from the database.

args:

  • the user’s authentification status

  • the current database

  • the id of the authkey

returns:

  • the response from the api after the deleting request

auth_keys_delete_auth_key_depr async 

auth_keys_delete_auth_key_depr(auth: Annotated[Auth, Depends(authorize(HYBRID))], db: Annotated[Session, Depends(get_db)], auth_key_id: Annotated[int, Path(alias=AuthKeyId)]) -> StandardStatusIdentifiedResponse

Delete AuthKey by AuthKeyId from the database.

args:

  • the user’s authentification status

  • the current database

  • the id of the authkey

returns:

  • the response from the api after the deleting request

auth_keys_edit_auth_key async 

auth_keys_edit_auth_key(auth: Annotated[Auth, Depends(authorize(HYBRID))], db: Annotated[Session, Depends(get_db)], auth_key_id: Annotated[int, Path(alias=AuthKeyId)], body: EditAuthKeyBody) -> EditAuthKeyResponseCompl

Edit an AuthKey by its ID.

args:

  • the user’s authentification status

  • the current database

  • the id of the authkey

  • the request body

returns:

  • the updated authkey

auth_keys_edit_auth_key_depr async 

auth_keys_edit_auth_key_depr(auth: Annotated[Auth, Depends(authorize(HYBRID))], db: Annotated[Session, Depends(get_db)], auth_key_id: Annotated[int, Path(alias=AuthKeyId)], body: EditAuthKeyBody) -> EditAuthKeyResponseCompl

Edit AuthKey by AuthKey ID.

args:

  • the user’s authentification status

  • the current database

  • the id of the authkey

  • the request body

returns:

  • the updated authkey

auth_keys_get async 

auth_keys_get(auth: Annotated[Auth, Depends(authorize(HYBRID))], db: Annotated[Session, Depends(get_db)]) -> list[SearchGetAuthKeysResponse]

Returns all AuthKeys stored in the database as a List.

args:

  • the user’s authentification status

  • the current database

returns:

  • all authkeys as a list

auth_keys_view_auth_key async 

auth_keys_view_auth_key(auth: Annotated[Auth, Depends(authorize(HYBRID))], db: Annotated[Session, Depends(get_db)], auth_key_id: Annotated[int, Path(alias=AuthKeyId)]) -> ViewAuthKeysResponse

View an AuthKey by its ID.

args:

  • the user’s authentification status

  • the current database

  • the id of the authkey

returns:

  • the authkey

auth_keys_view_own_auth_keys async 

auth_keys_view_own_auth_keys(auth: Annotated[Auth, Depends(authorize(HYBRID))], db: Annotated[Session, Depends(get_db)]) -> list[SearchGetAuthKeysResponseItem]

View own Authkeys.

args:

  • the user’s authentification status

  • the current database

  • the id of the user

returns:

  • the auth keys

auth_keys_view_own_auth_keys_depr async 

auth_keys_view_own_auth_keys_depr(auth: Annotated[Auth, Depends(authorize(HYBRID))], db: Annotated[Session, Depends(get_db)]) -> list[SearchGetAuthKeysResponse]

Deprecated. View own Authkeys by the old route.

args:

  • the user’s authentification status

  • the current database

  • the id of the user

returns:

  • the auth keys

search_auth_keys async 

search_auth_keys(auth: Annotated[Auth, Depends(authorize(HYBRID))], db: Annotated[Session, Depends(get_db)], body: SearchAuthKeyBody) -> list[SearchGetAuthKeysResponseItem]

Search for specific AuthKeys by parameters.

args:

  • the user’s authentification status

  • the current database

  • the request body

returns:

  • the authkeys