[{"label":"Latest (v1.0)","version":"latest"}]
csp

Get Principal MFA Audit Log

Description

Retrieves all the audits for the MFA de/activation, enable/disable, login, login using recovery code and recovery code generation/deletion. The events received are sorted by date in descending order ie the most recent ones will appear first. Note: startDate and endDate format is epoch time in milliseconds.
Principal user is identified via a token. The token should be passed in a header called csp-auth-token.

Access Policy

Role User Accounts Service Accounts (Client Credentials Applications)
All Roles ✔️

Request

Request

URL

URL


post
https://{api_host}/csp/gateway/iam/vmwid/api/principal/mfa/audit
Copy

Request Body

Request Body

PrincipalMfaAuditLogRequest of mimetype application/json Required
{
	"endDate": 0,
	"startDate": 0
}
integer as int64
startDate Required

Start Date


integer as int64
endDate Required

End Date


array of string
deviceNames Optional

Device names


array of string
eventIds Optional

Event Ids


integer as int32
pageLimit Optional

Page Limit


integer as int32
pageStart Optional

Page Start


array of string
actions Optional

Actions

Possible values are: MFA_ACTIVATION, MFA_DEACTIVATION, MFA_ENABLE, MFA_DISABLE, MFA_DEVICE_NAME_UPDATE, MFA_AUTHENTICATION_SUCCESS, MFA_AUTHENTICATION_FAILURE, MFA_RECOVERY_CODE_AUTHENTICATION_SUCCESS, MFA_RECOVERY_CODE_AUTHENTICATION_FAILURE, MFA_RECOVERY_CODES_GENERATION, AUTHENTICATION_WITHOUT_MFA

Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

Response Body

Response Body

200 OK returns PagedPostResponseMfaAuditLogDto of type application/json
{
	"itemsPerPage": 25,
	"results": [
		{
			"action": "string",
			"details": {
				"deviceName": "string"
			},
			"eventDate": 0,
			"eventId": "string",
			"modifiedBy": "string",
			"username": "string"
		}
	],
	"startIndex": 5,
	"totalResults": 2000
}
integer as int32
itemsPerPage Optional

Number of items per page.


array of MfaAuditLogDto
results Optional

Partial list of returned results.


integer as int32
startIndex Optional

Start index of the results.


integer as int32
totalResults Optional

Total number of results if available

Errors

Errors

400

End date must be greater than start date OR Start date cannot be of future OR Date should be given as epoch OR Specified action is not supported OR Cannot exceed the limit of 20 event ids OR Cannot exceed the limit of 20 device names ORCombination of page and size exceeds max limit of records fetch


401

Unauthenticated User


403

The user is forbidden to use the API


404

No user with given token exists


409

The request could not be processed due to a conflict


429

The user has sent too many requests


500

An unexpected error has occurred while processing the request

Code Samples

Code Samples

cURL Command

curl -X POST -H "Content-Type: application/json" -d '{"actions":["MFA_ACTIVATION, MFA_DEACTIVATION, MFA_ENABLE, MFA_DISABLE, MFA_DEVICE_NAME_UPDATE, MFA_AUTHENTICATION_SUCCESS, MFA_AUTHENTICATION_FAILURE, MFA_RECOVERY_CODE_AUTHENTICATION_SUCCESS, MFA_RECOVERY_CODE_AUTHENTICATION_FAILURE, MFA_RECOVERY_CODES_GENERATION, AUTHENTICATION_WITHOUT_MFA"],"deviceNames":["string"],"endDate":0,"eventIds":["string"],"pageLimit":0,"pageStart":0,"startDate":0}' https://{api_host}/csp/gateway/iam/vmwid/api/principal/mfa/audit
Vendor Extensions

Vendor Extensions

This operation contains the following vendor extensions defined in the spec:
x-required-roles: any
x-slo-tier: TIER2


[{"label":"Latest (v1.0)","version":"latest"}]
csp
Feedback

Was this page helpful?