AuditEvent

Represents an audit event including a user and affected entities.

Properties

Field	Data type
`id`	`string`
`timestamp`	`string`
`comment`	`string`
`action`	`AuditAction`
`relatedEntities`	`RelatedEntities`
`user`	`User`

Schema

Below, you can find a full schema of this object, in XML and JSON formats. You can choose what fields to submit depending on your current needs. Different methods might expect different fields: the best approach is to request this entity via GET and use the response as a base for the following POST request.

A link to another object implies that you can substitute it with the schema of the linked object, if it is required for your call.

<auditEvent comment="string" id="string" timestamp="string">
  <action id="string" name="string" pattern="string"/>
  <relatedEntities count="123">
    <entity>[[[relatedEntity...|relatedentity.html]]]</entity>
  </relatedEntities>
  <user email="string" enabled2FA="true" hasPassword="true" href="string" id="123456789" lastLogin="string" locator="string" name="string" password="string" realm="string" username="string">
    <properties>[[[properties...|properties.html]]]</properties>
    <roles>[[[roles...|roles.html]]]</roles>
    <groups>[[[groups...|groups.html]]]</groups>
    <avatars>[[[userAvatars...|useravatars.html]]]</avatars>
  </user>
</auditEvent>

{
  "action" : {
    "name" : "name",
    "pattern" : "pattern",
    "id" : "id"
  },
  "comment" : "comment",
  "id" : "id",
  "relatedEntities" : {
    "count" : 6,
    "entity" : [ {
      "agent" : "[[[agent...|agent.html]]]",
      "vcsRoot" : "[[[vcs-root...|vcsroot.html]]]",
      "test" : "[[[test...|test.html]]]",
      "change" : "[[[change...|change.html]]]",
      "project" : "[[[project...|project.html]]]",
      "type" : "type",
      "unknown" : true,
      "internalId" : "internalId",
      "problem" : "[[[problem...|problem.html]]]",
      "build" : "[[[build...|build.html]]]",
      "buildType" : "[[[buildType...|buildtype.html]]]",
      "text" : "text",
      "agentPool" : "[[[agentPool...|agentpool.html]]]",
      "user" : "[[[user...|user.html]]]",
      "group" : "[[[group...|group.html]]]"
    } ]
  },
  "user" : {
    "lastLogin" : "lastLogin",
    "roles" : {
      "role" : [ "[[[role...|role.html]]]" ]
    },
    "groups" : {
      "count" : 1,
      "group" : [ "[[[group...|group.html]]]" ]
    },
    "hasPassword" : true,
    "password" : "password",
    "enabled2FA" : true,
    "name" : "name",
    "realm" : "realm",
    "id" : 9,
    "href" : "href",
    "locator" : "locator",
    "email" : "email",
    "properties" : {
      "property" : [ {
        "inherited" : true,
        "name" : "name",
        "type" : "[[[type...|type.html]]]",
        "value" : "value"
      } ],
      "count" : 2,
      "href" : "href"
    },
    "username" : "username",
    "avatars" : {
      "urlToSize80" : "urlToSize80",
      "urlToSize28" : "urlToSize28",
      "urlToSize40" : "urlToSize40",
      "urlToSize32" : "urlToSize32",
      "urlToSize20" : "urlToSize20",
      "urlToSize64" : "urlToSize64",
      "urlToSize56" : "urlToSize56"
    }
  },
  "timestamp" : "timestamp"
}

Last modified: 27 March 2024