apicrud.auth.apikey
apikey
created 26-dec-2020 by richb@instantlinux.net monolith broken out 18-apr-2021
Functions
|
API key authentication for openapi securitySchemes |
Classes
|
- class apicrud.auth.apikey.APIKey(roles_from=None)
- access(apikey, otp=None)
Access using API key
- Parameters:
apikey (str) – the API key
otp (str) – 6 or 8-digit one-time password
- Returns:
uid, scopes (None if not authorized)
- Return type:
dict
- apicrud.auth.apikey.auth(apikey, required_scopes=None)
API key authentication for openapi securitySchemes
- Parameters:
apikey (str) – the key
required_scopes (list) – permissions requested
- Returns:
uid if successful (None otherwise)
- Return type:
dict