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, may have read-only access to the command API, or may have full access to the command API.

permissions:ecm

1 or 0

1: This API account may use the Endpoint Credential Manager API.
0: This API account may not use the Endpoint Credential Manager API.

permissions:reporting:support

1 or 0

1: This API account may use the reporting API.
0: This API account may not use the reporting API.