API Account Fields

These fields apply to the api_account_added, api_account_changed, and api_account_removed events.

Field	Value	Explanation
client_id	string	The OAuth client ID.
client_secret	******	Indicates the OAuth client secret. The actual string is never supplied.
comments	string	Any comments associated with this API account.
enabled	1 or 0	1: This API account is enabled. 0: This API account is disabled.
id	string	The unique identifier of the API account.
ip_addresses	comma- delimited list	The list of network address prefixes from which this account can authenticate.
name	string	The name of the API account.
permissions:backup	1 or 0	1: This API account may use the backup API. 0: This API account may not use the backup API.
permissions:command	deny read_only full_access	Whether this API account is disallowed to use the command API, has read-only access to the command API, or has full access to the command API.
permissions:reporting:archive	1 or 0	1: This API account may use the archive API. 0: This API account may not use the archive API.
permissions:reporting:license	1 or 0	1: This API account may use the license reporting API. 0: This API account may not use the license reporting API.
permissions:reporting:presentation	1 or 0	1: This API account may use the presentation reporting API. 0: This API account may not use the presentation reporting API.
permissions:reporting:support	1 or 0	1: This API account may use the support reporting API. 0: This API account may not use the support reporting API.
permissions:reporting:syslog	deny read_only full_access	Whether this API account is disallowed access syslog reports, has read-only access to syslog reports, or has full access to syslog reports.