Get a User Audit Report

post/accountmanager.audit/{TypeCode}/{id}

Retrieves a report based on user roles, user groups, and business roles.

Securitybasic or X-PriceFx-jwt
Request
path Parameters
TypeCode
required
string

Specify whether you want to retrieve a report based on user roles (R), user groups (UG), or business roles (BR).

Possible values: "R" "UG" "BR"
Example: R
id
required
string

Specify the idof the user role, user group, or business role for which you want to retrieve users. Call the /fetch/R, /fetch/UG, or /fetch/BR endpoint to retrieve a list with corresponding user roles, user groups, or business roles.

Example: 2
Request Body schema: application/json
object
Responses
200

OK

Response Schema: application/json
object
node
string
startRow
integer
Array of objects
Array
version
integer
typedId
string
loginName
string
firstName
string
lastName
string
email
string
Array of objects (UserGroup)
Array of objects (BusinessRole)
activated
boolean
workflowEmailingActivated
boolean
noSession
boolean
requireTFA
boolean
receiveAdminEmail
boolean
ssoOnly
boolean
platformManaged
boolean
firstLogin
boolean
lastTermsOfUseVersionAgreed
string
lastTermsOfUseAgreedDate
string
Array of objects
roleNames
Array of strings
allRoleNames
Array of strings
createDate
string
createdBy
integer
lastUpdateBy
integer
endRow
integer
totalRows
integer
status
integer
Request samples
application/json
{ }
Response samples
application/json
{
  • "response": {
    • "node": "string",
    • "startRow": 0,
    • "data": [
      • {
        • "version": 0,
        • "typedId": "string",
        • "loginName": "string",
        • "firstName": "string",
        • "lastName": "string",
        • "email": "string",
        • "groups": [
          ],
        • "businessRoles": [
          ],
        • "activated": true,
        • "workflowEmailingActivated": true,
        • "noSession": true,
        • "requireTFA": true,
        • "receiveAdminEmail": true,
        • "ssoOnly": true,
        • "platformManaged": true,
        • "firstLogin": true,
        • "lastTermsOfUseVersionAgreed": "string",
        • "lastTermsOfUseAgreedDate": "string",
        • "allGroups": [
          ],
        • "roleNames": [
          ],
        • "allRoleNames": [
          ],
        • "createDate": "string",
        • "createdBy": 0,
        • "lastUpdateBy": 0
        }
      ],
    • "endRow": 0,
    • "totalRows": 0,
    • "status": 0
    }
}