Legacy Dev Forum Posts

 View Only

Sign Up

Back to discussions
Expand all | Collapse all

AuditApi - PeoplePermissions AccessToken response question

  • 1.  AuditApi - PeoplePermissions AccessToken response question

    Posted 06-05-2025 18:24

    Lloyd | 2022-11-14 02:27:21 UTC | #1

    I'm making the following request to the /api/v2/audits/query endpoint.

    { "interval": "2022-11-13T00:00:00/2022-11-15T00:00:00", "serviceName": "PeoplePermissions", "filters": [ { "property": "EntityType", "value": "AccessToken" } ] }

    I get back an array of responses, which all contain the message body of: ... "message": { "localizableMessageCode": "ACCESSTOKENCREATE_SUCCESS", "message": "access token created", "messageWithParams": "", "messageParams": {} }, ... So my questions are:

    • Are there other responses/messages for a user failing to login, or token failed to be created due to bad username/password, etc .
    • was the Genesys design approach for the AuditApi to log an audit trail of successful requests, but not of failed/unauthorized requests?

    Thanks L

    jacobshaw | 2022-11-14 18:36:23 UTC | #2

    Hi @Lloyd, There is another audit event for a failure to create an access token. A possible response would be

    "message": {
  "localizableMessageCode": "ACCESS_TOKEN_CREATE_FAILURE",
  "message": "failed to create access token",
  "messageWithParams": "",
  "messageParams": {}
},

    Lloyd | 2022-11-14 18:50:00 UTC | #3

    Thanks @jacobshaw

    Would that event be generated when a user had correct password but the system failed to generate a token? or would it occur if the user had used the wrong password?

    Lloyd

    jacobshaw | 2022-11-15 16:11:13 UTC | #4

    @Lloyd I may have spoken too soon about the failure response. I found that this event type exists in our code, but I haven't been able to produce a response with that message.

    However I recommend using this API resource to see other filter options to get login events: https://developer.genesys.cloud/devapps/api-explorer#get-api-v2-audits-query-servicemapping

    I recommend something like:

    {
  "interval": "2022-11-13T00:00:00/2022-11-15T00:00:00",
  "serviceName": "PeoplePermissions",
  "filters": [
    {
      "property": "EntityType",
      "value": "AuthUser"
    }
  ]
}

    A possible response (which I have verified with a query) contains this:

    "message": {
        "localizableMessageCode": "INCORRECT_PASSWORD",
        "message": "incorrect password",
        "messageWithParams": "",
        "messageParams": {}
}

    Lloyd | 2022-11-14 20:40:45 UTC | #5

    Fantastic @jacobshaw - That's perfect. Thanks for your time/help!

    system | 2022-12-15 20:41:23 UTC | #6

    This topic was automatically closed 31 days after the last reply. New replies are no longer allowed.

    This post was migrated from the old Developer Forum.

    ref: 17195



Related Content