Get MFA Events - Security Cloud Control Firewall Manager API Documentation

{"type":"api","title":"Get MFA Events","meta":{"id":"/apps/pubhub/media/cdo-api-documentation/ee9bdf946673e45c4f256a22e0a754e29a9b2098/9b0e4c9a-48cb-3530-a00a-1f32fbf2438c","info":{"title":"Cisco Security Cloud Control Firewall Manager API","version":"1.15.0","description":"Use the documentation to explore the endpoints Security Cloud Control Firewall Manager has to offer","contact":{"name":"Cisco Security Cloud Control TAC","email":"cdo.tac@cisco.com"}},"openapi":"3.0.1","servers":[{"url":"https://api.us.security.cisco.com/firewall","description":"US"},{"url":"https://api.eu.security.cisco.com/firewall","description":"EU"},{"url":"https://api.apj.security.cisco.com/firewall","description":"APJ"},{"url":"https://api.au.security.cisco.com/firewall","description":"AUS"},{"url":"https://api.in.security.cisco.com/firewall","description":"IN"},{"url":"https://api.int.security.cisco.com/firewall","description":"Staging"},{"url":"https://scale.manage.security.cisco.com/api/rest","description":"Scale"},{"url":"https://ci.manage.security.cisco.com/api/rest","description":"CI"},{"url":"https://manage.stg.secure.cisco/api/rest","description":"Stgf9"}],"securitySchemes":{"bearerAuth":{"bearerFormat":"JWT","scheme":"bearer","type":"http"}}},"spec":{"description":"Get a list of MFA events.","operationId":"getMfaEvents","parameters":[{"description":"Number of results to retrieve.","in":"query","name":"limit","required":false,"schema":{"maximum":200,"minimum":0,"type":"string"}},{"description":"Offset of the results retrieved. The Security Cloud Control APIs use the offset field to determine the index of the first result retrieved, and will retrieve `limit` results from the offset specified.","in":"query","name":"offset","required":false,"schema":{"minimum":0,"type":"string"}},{"description":"The query to execute. Use the Lucene Query Syntax to construct your query.","example":"fieldName:fieldValue","in":"query","name":"q","required":false,"schema":{"type":"string"}},{"description":"The fields to sort results by.","example":"name:DESC","in":"query","name":"sort","required":false,"schema":{"items":{"type":"string"},"type":"array"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"count":{"description":"The total number of results available.","example":100,"format":"int32","type":"integer"},"items":{"description":"The list of items retrieved.","items":{"properties":{"application":{"description":"The name of the application associated with the MFA event.","example":"Security Cloud Sign On Preview","type":"string"},"clientDevice":{"description":"The client device that triggered this MFA event.","properties":{"browser":{"description":"The web browser running on the client device.","properties":{"name":{"description":"The name of the web browser running on the client device.","example":"Chrome","type":"string"},"version":{"description":"The version of the web browser running on the client device.","example":"121.0.6167.160","type":"string"}},"type":"object","$$ref":"#/components/schemas/Browser"},"encrypted":{"description":"Indicates whether encryption is enabled on the client device.","example":true,"type":"boolean"},"firewalled":{"description":"Indicates whether a firewall is enabled on the client device.","example":true,"type":"boolean"},"ipAddress":{"description":"The IP address of the client device that has triggered this MFA event.","example":"106.51.163.157","type":"string"},"location":{"description":"The location of the client device.","properties":{"city":{"description":"The city where the client device is located.","example":"San Jose","type":"string"},"country":{"description":"The country where the client device is located.","example":"United States","type":"string"},"subdivision":{"description":"The subdivision (e.g., state or province) where the client device is located.","example":"California","type":"string"}},"type":"object","$$ref":"#/components/schemas/Location"},"os":{"description":"The operating system of the client device.","properties":{"type":{"description":"The type of operating system running on the client device.","example":"mac-intel","type":"string"},"version":{"description":"The version of the operating system running on the client device.","example":"14.2.1","type":"string"}},"type":"object","$$ref":"#/components/schemas/OS"},"passwordSet":{"description":"Indicates whether a password is set on the client device.","example":false,"type":"boolean"},"uid":{"description":"The unique identifier, represented as a UUID, of the device.","example":"7131daad-e813-4b8f-8f42-be1e241e8cdb","format":"uuid","type":"string"}},"required":["uid"],"type":"object","$$ref":"#/components/schemas/ClientDevice"},"reason":{"description":"The reason for the result of the MFA event. When the `result` is `DENIED`, this field contains information on why the MFA event failed.","example":"valid_passcode","type":"string"},"result":{"description":"The result of the MFA event.","enum":["DENIED","GRANTED"],"example":"GRANTED","type":"string"},"secondFactor":{"description":"The second factor used for the MFA event.","example":"sms_passcode","type":"string"},"timestamp":{"description":"The time (in UTC) at which the user logged in to the MFA event, represented using the RFC-3339 standard.","example":"2023-12-13T05:15:44Z","format":"date-time","type":"string"},"uid":{"description":"The unique identifier, represented as a UUID, of the MFA event.","example":"7131daad-e813-4b8f-8f42-be1e241e8cdb","format":"uuid","type":"string"},"username":{"description":"The name of the user associated with the MFA event.","example":"user@example.com","type":"string"}},"required":["uid","username"],"type":"object","$$ref":"#/components/schemas/MfaEvent"},"type":"array"},"limit":{"description":"The number of results retrieved.","example":50,"format":"int32","type":"integer"},"offset":{"description":"The offset of the results retrieved. The Security Cloud Control API uses the offset field to determine the index of the first result retrieved, and will retrieve `limit` results from the offset specified.","example":0,"format":"int32","type":"integer"}},"type":"object","$$ref":"#/components/schemas/MfaEventPage"}}},"description":"List of MFA events"},"400":{"content":{"application/json":{"schema":{"properties":{"details":{"additionalProperties":{"description":"Additional details, if any, about the error.","example":{},"type":"object"},"description":"Additional details, if any, about the error.","example":{},"type":"object"},"errorCode":{"description":"Unique code that describes the error.","enum":["INVALID_INPUT","UNAUTHORIZED","FORBIDDEN","NOT_FOUND","METHOD_NOT_ALLOWED","CONFLICT","TOO_MANY_REQUESTS","SERVER_ERROR","PROXY_ERROR","BAD_REQUEST","UNPROCESSABLE_ENTITY"],"example":"INVALID_INPUT","type":"string"},"errorMsg":{"description":"Human-readable error description in English.","example":"sample error","type":"string"}},"$$ref":"#/components/schemas/CommonApiError"}}},"description":"Invalid input provided. Check the response for details.","$$ref":"#/components/responses/http400BadRequest"},"401":{"content":{"application/json":{"schema":{"properties":{"error":{"description":"A human-readable error description in English.","example":"invalid_token","type":"string"},"errorDescription":{"description":"A human-readable error description in English.","example":"Your token is invalid","type":"string"}},"$$ref":"#/components/schemas/AuthenticationError"}}},"description":"Request not authorized.","$$ref":"#/components/responses/http401Unauthorised"},"403":{"content":{"application/json":{"schema":{"properties":{"details":{"additionalProperties":{"description":"Additional details, if any, about the error.","example":{},"type":"object"},"description":"Additional details, if any, about the error.","example":{},"type":"object"},"errorCode":{"description":"Unique code that describes the error.","enum":["INVALID_INPUT","UNAUTHORIZED","FORBIDDEN","NOT_FOUND","METHOD_NOT_ALLOWED","CONFLICT","TOO_MANY_REQUESTS","SERVER_ERROR","PROXY_ERROR","BAD_REQUEST","UNPROCESSABLE_ENTITY"],"example":"INVALID_INPUT","type":"string"},"errorMsg":{"description":"Human-readable error description in English.","example":"sample error","type":"string"}},"$$ref":"#/components/schemas/CommonApiError"}}},"description":"User does not have sufficient privileges to perform this operation.","$$ref":"#/components/responses/http403Forbidden"},"405":{"content":{"application/json":{"schema":{"properties":{"details":{"additionalProperties":{"description":"Additional details, if any, about the error.","example":{},"type":"object"},"description":"Additional details, if any, about the error.","example":{},"type":"object"},"errorCode":{"description":"Unique code that describes the error.","enum":["INVALID_INPUT","UNAUTHORIZED","FORBIDDEN","NOT_FOUND","METHOD_NOT_ALLOWED","CONFLICT","TOO_MANY_REQUESTS","SERVER_ERROR","PROXY_ERROR","BAD_REQUEST","UNPROCESSABLE_ENTITY"],"example":"INVALID_INPUT","type":"string"},"errorMsg":{"description":"Human-readable error description in English.","example":"sample error","type":"string"}},"$$ref":"#/components/schemas/CommonApiError"}}},"description":"Method not allowed.","$$ref":"#/components/responses/http405MethodNotAllowed"},"500":{"content":{"application/json":{"schema":{"properties":{"details":{"additionalProperties":{"description":"Additional details, if any, about the error.","example":{},"type":"object"},"description":"Additional details, if any, about the error.","example":{},"type":"object"},"errorCode":{"description":"Unique code that describes the error.","enum":["INVALID_INPUT","UNAUTHORIZED","FORBIDDEN","NOT_FOUND","METHOD_NOT_ALLOWED","CONFLICT","TOO_MANY_REQUESTS","SERVER_ERROR","PROXY_ERROR","BAD_REQUEST","UNPROCESSABLE_ENTITY"],"example":"INVALID_INPUT","type":"string"},"errorMsg":{"description":"Human-readable error description in English.","example":"sample error","type":"string"}},"$$ref":"#/components/schemas/CommonApiError"}}},"description":"Internal server error."}},"security":[{"bearerAuth":[]}],"summary":"Get MFA Events","tags":["Remote Access Monitoring"],"__originalOperationId":"getMfaEvents","method":"get","path":"/v1/mfaevents"}}