ApiKeyPayload.md

ElasticEmail.model.api_key_payload.ApiKeyPayload

Create a new ApiKey

Model Type Info

Input Type	Accessed Type	Description	Notes
dict, frozendict.frozendict,	frozendict.frozendict,	Create a new ApiKey

Dictionary Keys

Key	Input Type	Accessed Type	Description	Notes
AccessLevel	list, tuple,	tuple,	Access level or permission to be assigned to this ApiKey.
Name	str,	str,	Name of the ApiKey for ease of reference.
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]
Subaccount	str,	str,	Email of the subaccount for which this ApiKey should be created	[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]