logs_audits
Creates, updates, deletes, gets or lists a logs_audits resource.
Overview​
| Name | logs_audits |
| Type | Resource |
| Id | ovh.me.logs_audits |
Fields​
The following fields are returned by SELECT queries:
- list
An audit Log
| Name | Datatype | Description |
|---|---|---|
auth_details | object | authentication details (wire: authDetails) |
created_at | string (date-time) | event's date (wire: createdAt) |
group_created_details | object | specific fields for GROUP_CREATED events (wire: groupCreatedDetails) |
group_deleted_details | object | specific fields for GROUP_DELETED events (wire: groupDeletedDetails) |
group_modified_details | object | specific fields for GROUP_MODIFIED events (wire: groupModifiedDetails) |
ip | string (ipv4) | IP associated to this event (example: 192.0.2.0) |
login_success_details | object | specific fields for LOGIN_SUCCESS events (wire: loginSuccessDetails) |
policy_created_details | object | specific fields for POLICY_CREATED events (wire: policyCreatedDetails) |
policy_deleted_details | object | specific fields for POLICY_DELETED events (wire: policyDeletedDetails) |
policy_modified_details | object | specific fields for POLICY_MODIFIED events (wire: policyModifiedDetails) |
provider_created_details | object | specific fields for PROVIDER_CREATED events (wire: providerCreatedDetails) |
provider_deleted_details | object | specific fields for PROVIDER_DELETED events (wire: providerDeletedDetails) |
provider_modified_details | object | specific fields for PROVIDER_MODIFIED events (wire: providerModifiedDetails) |
resource_group_created_details | object | specific fields for RESOURCE_GROUP_CREATED events (wire: resourceGroupCreatedDetails) |
resource_group_deleted_details | object | specific fields for RESOURCE_GROUP_DELETED events (wire: resourceGroupDeletedDetails) |
resource_group_modified_details | object | specific fields for RESOURCE_GROUP_MODIFIED events (wire: resourceGroupModifiedDetails) |
token_created_details | object | specific fields for TOKEN_CREATED events (wire: tokenCreatedDetails) |
token_deleted_details | object | specific fields for TOKEN_DELETED events (wire: tokenDeletedDetails) |
token_modified_details | object | specific fields for TOKEN_MODIFIED events (wire: tokenModifiedDetails) |
type | string | type of event (ACCOUNT_PASSWORD_CHANGED, GROUP_CREATED, GROUP_DELETED, GROUP_MODIFIED, LOGIN_SUCCESS, POLICY_CREATED, POLICY_DELETED, POLICY_MODIFIED, PROVIDER_CREATED, PROVIDER_DELETED, PROVIDER_MODIFIED, RESOURCE_GROUP_CREATED, RESOURCE_GROUP_DELETED, RESOURCE_GROUP_MODIFIED, TOKEN_CREATED, TOKEN_DELETED, TOKEN_MODIFIED, USER_CREATED, USER_DELETED, USER_MODIFIED, USER_PASSWORD_CHANGED) |
user_created_details | object | specific fields for USER_CREATED events (wire: userCreatedDetails) |
user_deleted_details | object | specific fields for USER_DELETED events (wire: userDeletedDetails) |
user_modified_details | object | specific fields for USER_MODIFIED events (wire: userModifiedDetails) |
user_password_changed_details | object | specific fields for USER_PASSWORD_CHANGED events (wire: userPasswordChangedDetails) |
Methods​
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
list | select | Get your audit logs (Alpha version) | ||
log_url | exec | kind | Generate a temporary URL to retrieve logs |
Parameters​
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
api_host | string | The OVHcloud API host. Selected by OVH_ENDPOINT (ovh-eu, ovh-ca or ovh-us; default ovh-eu). (default: api.eu.ovhcloud.com, x-stackQL-envVarSelector: {"envVar":"OVH_ENDPOINT","default":"ovh-eu","values":{"ovh-eu":"api.eu.ovhcloud.com","ovh-ca":"api.ca.ovhcloud.com","ovh-us":"api.us.ovhcloud.com"}}) |
SELECT examples​
- list
Get your audit logs (Alpha version)
SELECT
auth_details,
created_at,
group_created_details,
group_deleted_details,
group_modified_details,
ip,
login_success_details,
policy_created_details,
policy_deleted_details,
policy_modified_details,
provider_created_details,
provider_deleted_details,
provider_modified_details,
resource_group_created_details,
resource_group_deleted_details,
resource_group_modified_details,
token_created_details,
token_deleted_details,
token_modified_details,
type,
user_created_details,
user_deleted_details,
user_modified_details,
user_password_changed_details
FROM ovh.me.logs_audits
;
Lifecycle Methods​
EXEC variables use wire (API) names.
- log_url
Generate a temporary URL to retrieve logs
EXEC ovh.me.logs_audits.log_url
@@json=
'{
"kind": "{{ kind }}"
}'
;