Skip to content

Latest commit

 

History

History
51 lines (38 loc) · 2.7 KB

NewApiKey.md

File metadata and controls

51 lines (38 loc) · 2.7 KB

ElasticEmail.model.new_api_key.NewApiKey

Newly generated ApiKey with Token

Model Type Info

Input Type Accessed Type Description Notes
dict, frozendict.frozendict, frozendict.frozendict, Newly generated ApiKey with Token

Dictionary Keys

Key Input Type Accessed Type Description Notes
Token str, str, Unique token to be used in the system [optional]
AccessLevel list, tuple, tuple, Access level or permission to be assigned to this ApiKey. [optional]
Name str, str, Name of the ApiKey. [optional]
DateCreated str, datetime, str, Date this ApiKey was created. [optional] value must conform to RFC-3339 date-time
LastUse None, str, datetime, NoneClass, str, Date this ApiKey was last used. [optional] value must conform to RFC-3339 date-time
Expires None, str, datetime, NoneClass, str, Date this ApiKey expires. [optional] value must conform to RFC-3339 date-time
RestrictAccessToIPRange list, tuple, tuple, Which IPs can use this ApiKey [optional]
any_string_name dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO any string name can be used but the value must be the correct type [optional]

AccessLevel

Access level or permission to be assigned to this ApiKey.

Model Type Info

Input Type Accessed Type Description Notes
list, tuple, tuple, Access level or permission to be assigned to this ApiKey.

Tuple Items

Class Name Input Type Accessed Type Description Notes
AccessLevel AccessLevel AccessLevel

RestrictAccessToIPRange

Which IPs can use this ApiKey

Model Type Info

Input Type Accessed Type Description Notes
list, tuple, tuple, Which IPs can use this ApiKey

Tuple Items

Class Name Input Type Accessed Type Description Notes
items str, str,

[Back to Model list] [Back to API list] [Back to README]