datacatalog.tokens package¶
Submodules¶
datacatalog.tokens.admin module¶
-
exception
datacatalog.tokens.admin.
InvalidAdminToken
[source]¶ Bases:
datacatalog.tokens.exceptions.InvalidToken
Raised when an administrative token is invalid
-
datacatalog.tokens.admin.
get_admin_token
(key, previous=False)[source]¶ Returns a token with administrative priviledges
Administrative tokens provide a signature that can be used to authorize edits and to trigger specific administrative events.
Parameters: Returns: Token
-
datacatalog.tokens.admin.
validate_admin_token
(token, key=None, permissive=True)[source]¶ Validate an adminstrative token
Only administrative tokens can be validated using this function.
Parameters: Raises: InvalidAdminToken
– The outcome when validation fails and permissive is not set.Returns: If permissive is set, validity is a Boolean value
Return type:
datacatalog.tokens.classes module¶
datacatalog.tokens.exceptions module¶
-
exception
datacatalog.tokens.exceptions.
InvalidToken
[source]¶ Bases:
ValueError
Raised when a token is invalid
-
exception
datacatalog.tokens.exceptions.
InvalidAdminToken
[source]¶ Bases:
datacatalog.tokens.exceptions.InvalidToken
Raised when an administrative token is invalid
datacatalog.tokens.salt module¶
datacatalog.tokens.token module¶
-
datacatalog.tokens.token.
get_token
(salt, *args)[source]¶ Deterministically generates a token from arguments
Tokens provide a minimal signature that can be used to authorize edits to a record managed by datacatalog.
Parameters: salt (str) – Returns: An alphanumeric token Return type: Token
-
datacatalog.tokens.token.
validate_token
(token, salt=None, *args, permissive=True)[source]¶ Validate a token
Both record-level tokens and administrative tokens can be validated using this function.
Parameters: Raises: InvalidToken
– The outcome when validation fails and permissive is not set.Returns: If permissive is set, validity is a Boolean value
Return type: