Get Principal Mfa Audit Log Using POST

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

URI

POST

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

COPY

Request Body

PrincipalMfaAuditLogRequest of type(s) application/json

Required

{
    "actions": [
        "string"
    ],
    "deviceNames": [
        "string"
    ],
    "endDate": 0,
    "eventIds": [
        "string"
    ],
    "pageLimit": 0,
    "pageStart": 0,
    "startDate": 0
}

array of string

actions

Optional

Actions

array of string

deviceNames

Optional

The device names

integer As int64 As int64

endDate

Required

End Date

array of string

eventIds

Optional

The event ids

integer As int32 As int32

pageLimit

Optional

The maximum results per page

integer As int32 As int32

pageStart

Optional

The index that the set of results will begin with

integer As int64 As int64

startDate

Required

Start Date

Authentication

This operation uses the following authentication methods.

Bearer

Responses

200

Returns PagedPostResponseMfaAuditLogDto of type(s) 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 As int32

itemsPerPage

Optional

Number of items per page.

array of MfaAuditLogDto

results

Optional

Partial list of returned results.

integer As int32 As int32

startIndex

Optional

Start index of the results.

integer As int32 As int32

totalResults

Optional

Total number of results if available

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

Returns CspErrorResponse of type(s) application/json

{
    "cspErrorCode": "string",
    "errorCode": "string",
    "message": "string",
    "moduleCode": 0,
    "requestId": "string",
    "statusCode": 0
}

string

cspErrorCode

Optional

cspErrorCode

string

errorCode

Optional

errorCode

string

message

Optional

message

integer As int32 As int32

moduleCode

Optional

moduleCode

string

requestId

Optional

requestId

integer As int32 As int32

statusCode

Optional

statusCode

401

Unauthenticated User

Returns CspErrorResponse of type(s) application/json

{
    "cspErrorCode": "string",
    "errorCode": "string",
    "message": "string",
    "moduleCode": 0,
    "requestId": "string",
    "statusCode": 0
}

string

cspErrorCode

Optional

cspErrorCode

string

errorCode

Optional

errorCode

string

message

Optional

message

integer As int32 As int32

moduleCode

Optional

moduleCode

string

requestId

Optional

requestId

integer As int32 As int32

statusCode

Optional

statusCode

403

The user is forbidden to use the API

Returns CspErrorResponse of type(s) application/json

{
    "cspErrorCode": "string",
    "errorCode": "string",
    "message": "string",
    "moduleCode": 0,
    "requestId": "string",
    "statusCode": 0
}

string

cspErrorCode

Optional

cspErrorCode

string

errorCode

Optional

errorCode

string

message

Optional

message

integer As int32 As int32

moduleCode

Optional

moduleCode

string

requestId

Optional

requestId

integer As int32 As int32

statusCode

Optional

statusCode

404

No user with given token exists

Returns CspErrorResponse of type(s) application/json

{
    "cspErrorCode": "string",
    "errorCode": "string",
    "message": "string",
    "moduleCode": 0,
    "requestId": "string",
    "statusCode": 0
}

string

cspErrorCode

Optional

cspErrorCode

string

errorCode

Optional

errorCode

string

message

Optional

message

integer As int32 As int32

moduleCode

Optional

moduleCode

string

requestId

Optional

requestId

integer As int32 As int32

statusCode

Optional

statusCode

409

The request could not be processed due to a conflict

Returns CspErrorResponse of type(s) application/json

{
    "cspErrorCode": "string",
    "errorCode": "string",
    "message": "string",
    "moduleCode": 0,
    "requestId": "string",
    "statusCode": 0
}

string

cspErrorCode

Optional

cspErrorCode

string

errorCode

Optional

errorCode

string

message

Optional

message

integer As int32 As int32

moduleCode

Optional

moduleCode

string

requestId

Optional

requestId

integer As int32 As int32

statusCode

Optional

statusCode

429

The user has sent too many requests

Returns CspErrorResponse of type(s) application/json

{
    "cspErrorCode": "string",
    "errorCode": "string",
    "message": "string",
    "moduleCode": 0,
    "requestId": "string",
    "statusCode": 0
}

string

cspErrorCode

Optional

cspErrorCode

string

errorCode

Optional

errorCode

string

message

Optional

message

integer As int32 As int32

moduleCode

Optional

moduleCode

string

requestId

Optional

requestId

integer As int32 As int32

statusCode

Optional

statusCode

500

An unexpected error has occurred while processing the request

Returns CspErrorResponse of type(s) application/json

{
    "cspErrorCode": "string",
    "errorCode": "string",
    "message": "string",
    "moduleCode": 0,
    "requestId": "string",
    "statusCode": 0
}

string

cspErrorCode

Optional

cspErrorCode

string

errorCode

Optional

errorCode

string

message

Optional

message