JSON objects

User

Name	Type	Default value	Description
id	String		User identifier (uuid4)
firstname	String		User firstname
lastname	String		User lastname
email	String		User email address
expires_at	Date		The user expiration date
customer_id	Integer		The customer identifier associated to the user
phone	String		User phone number
language	String		User language. Allowed values : en, fr, de
last_login_at	Datetime		The date and time of the last user's connection, made with one of his accesses
created_at	Datetime		The user creation datetime
created_by	Author		The access that created the user
updated_at	Datetime		The user last update datetime
updated_by	Author		The access that updated the user

UserSearchResult

Name	Type	Default value	Description
total	Integer		Total number of users matching the search criteria
limit	Integer	100	Number of users returned
offset	Integer	0	Offset used
results	List of User		List of users matching the search criteria

---

Access

Name	Type	Default value	Description
id	Integer		The identifier of the access
user	String		The user identifier
type	String		The access type. Allowed values : ui_connection, sso_connection, api_connection, profile
customer_id	Integer		The customer identifier associated to the access
roles	List of String	[]	The roles associated to the access
last_login_at	Datetime		The date and time of the last access' connection
created_at	Datetime		The access creation datetime
created_by	Author		The access that created this access
two_fa_enabled	Boolean		Only on an ui_connection access. Does this access require two-factor authentication?
sso_id	String		Only on an sso_connection access. The access identifier on your Single Sign On authentication system
name	String		Only on an api_connection or profile access. The name of the access. It can be used to differentiate between several accesses.
language	String		Only on an api_connection access. Access language. Allowed values : en, fr, de

UserAccessListResult

Name	Type	Default value	Description
total	Integer		Total number of access
results	List of Access		List of access

AccessSearchResult

Name	Type	Default value	Description
total	Integer		Total number of access matching the search criteria
limit	Integer	100	Number of access returned
offset	Integer	0	Offset used
results	List of Access		List of access matching the search criteria

---

Token

Name	Type	Default value	Description
id	Integer		The token identifier
token	String		The token value
expires_at	Datetime		The token expiration datetime
created_at	Datetime		The token creation datetime
updated_at	Datetime		The token last update datetime

---

Role

Name	Type	Default value	Description
id	String		The role identifier
description	String		The role description
permissions	List of Permission		The set of permissions constituting this role

Role Summary

Name	Type	Default value	Description
id	String		The role identifier
description	String		The role description

RoleListResult

Name	Type	Default value	Description
total	Integer		Total number of roles
results	List of Role Summary		List of roles

Permission

Name	Type	Default value	Description
id	String		The permission identifier
description	String		The permission description

---

Author

Name	Type	Default value	Description
id	String		The identifier of the author
firstname	String		The firstname of the author
lastname	String		The lastname of the author

---

ResourceType

Enum representing the types of resources that can be authorized in permission operations.

Value	Description
zone	DNS zone resource type

Additional resource types may be added in future versions of the API.

---