User

Model of User

Field	Type	Description	Required	Default
agrees_with_tos	Date	Date the user agree with terms of service	Optional	None
api_quota	Integer	None	Optional	None
api_daily_quota	Integer	None	Optional	None
apikeys	Mapping [String, ApiKey]	None	Yes	See ApiKey for more details.
apps	Mapping [String, Apps]	Applications with access to the account	Yes	See Apps for more details.
can_impersonate	Boolean	Allowed to query on behalf of others?	Yes	False
classification	Classification	Maximum classification for the user	Yes	TLP:C
dn	Keyword	User's LDAP DN	Optional	None
email	Email	User's email address	Optional	None
organization	Text	Organization the user belongs to	Optional	None
groups	List [UpperKeyword]	List of groups the user submits to	Yes	[]
identity_id	Keyword	ID of the matching object in your identity provider (used for logging in as another application)	Optional	None
is_active	Boolean	Is the user active?	Yes	True
name	Keyword	Full name of the user	Yes	None
otp_sk	Keyword	Secret key to generate one time passwords	Optional	None
password	Keyword	BCrypt hash of the user's password	Yes	None
submission_quota	Integer	None	Optional	None
submission_async_quota	Integer	None	Optional	None
submission_daily_quota	Integer	None	Optional	None
type	List [Enum]	Type of user	Yes	['user']
roles	List [Enum]	Default roles for user	Yes	[]
security_tokens	Mapping [String, Keyword]	Map of security tokens	Yes	{}
uname	Keyword	Username	Yes	None

ApiKey

Model for API keys

Field	Type	Description	Required	Default
acl	List [Enum]	Access Control List for the API key	Yes	None
password	Keyword	BCrypt hash of the password for the apikey	Yes	None
roles	List [Enum]	List of roles tied to the API key	Yes	[]

Apps

Model of Apps used of OBO (On Behalf Of)

Field	Type	Description	Required	Default
client_id	Keyword	Username allowed to impersonate the current user	Yes	None
netloc	Keyword	DNS hostname for the server	Yes	None
scope	Enum	Scope of access for the App token Supported values are: "c", "r", "rw", "w"	Yes	None
server	Keyword	Name of the server that has access	Yes	None
roles	List [Enum]	List of roles tied to the App token	Yes	[]