Do not miss any Audit Logs API changes, ever again

Subscribe to the Audit Logs API changelog to be up to date on recent changes.

RSS

about 1 hour ago

main
1.0
Compare

API structure has changed

Next change
6 structure changes including:
1 Breaking change
1 Addition
4 Modifications
1 Removal
Modified 4 Breaking
GET /api/v1.0/organizations/{organizationGuid}/audit-trails
  • Response
  • 200 response Modified
    • application/json content type Modified
      • continuationToken property Modified
        • Property is now required
          Breaking
        • Type went from string | null to null | string
      • responseData property Modified
        • Property is now required
          Breaking
        • Type went from array[object] | null to null | array[object]
        • id, organizationId, auditEvent, auditEntity, auditAction, coreEntity, coreEntityId, timestamp properties Modified
          • Properties are now required
            Breaking
        • contractedEntity property Modified
          • Property is now required
            Breaking
          • Type went from string | null to null | string
        • contractedEntityId property Modified
          • Property is now required
            Breaking
          • Type went from string(uuid) | null to null | string(uuid)
        • oldValue, newValue properties Modified
          • Properties are now required
            Breaking
          • Type went from object | null to null | object
        • diff property Modified
          • Property is now required
            Breaking
          • Type went from array[object] | null to null | array[object]
        • author, message properties Modified
      • hasMoreChanges property Modified
        • Property is now required
          Breaking
  • 400 response Modified
    • application/problem+json content type Modified
      • type, title, detail, instance properties Modified
        • Type went from string | null to string
          Breaking
      • status property Modified
        • Type went from integer(int32) | null to integer(int32)
          Breaking
  • 401 response Modified
    • application/problem+json content type Modified
      • type, title, detail, instance properties Modified
        • Type went from string | null to string
          Breaking
      • status property Modified
        • Type went from integer(int32) | null to integer(int32)
          Breaking
  • 403 response Modified
    • application/problem+json content type Modified
      • type, title, detail, instance properties Modified
        • Type went from string | null to string
          Breaking
      • status property Modified
        • Type went from integer(int32) | null to integer(int32)
          Breaking
  • 404 response Modified
    • application/problem+json content type Modified
      • type, title, detail, instance properties Modified
        • Type went from string | null to string
          Breaking
      • status property Modified
        • Type went from integer(int32) | null to integer(int32)
          Breaking
  • default response Modified
    • application/problem+json content type Modified
      • type, title, detail, instance properties Modified
        • Type went from string | null to string
          Breaking
      • status property Modified
        • Type went from integer(int32) | null to integer(int32)
          Breaking
  • Authentication
  • Http bearer token authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • Adra personal access token authentication method Added
GET /api/v1.0/organizations/{organizationGuid}/audit-trails/status
  • Response
  • 200 response Modified
    • application/json content type Modified
      • hasMoreChanges property Modified
        • Property is now required
          Breaking
      • continuationToken property Modified
        • Property is now required
          Breaking
        • Type went from string | null to null | string
  • 400 response Modified
    • application/problem+json content type Modified
      • type, title, detail, instance properties Modified
        • Type went from string | null to string
          Breaking
      • status property Modified
        • Type went from integer(int32) | null to integer(int32)
          Breaking
  • 401 response Modified
    • application/problem+json content type Modified
      • type, title, detail, instance properties Modified
        • Type went from string | null to string
          Breaking
      • status property Modified
        • Type went from integer(int32) | null to integer(int32)
          Breaking
  • 403 response Modified
    • application/problem+json content type Modified
      • type, title, detail, instance properties Modified
        • Type went from string | null to string
          Breaking
      • status property Modified
        • Type went from integer(int32) | null to integer(int32)
          Breaking
  • 404 response Modified
    • application/problem+json content type Modified
      • type, title, detail, instance properties Modified
        • Type went from string | null to string
          Breaking
      • status property Modified
        • Type went from integer(int32) | null to integer(int32)
          Breaking
  • default response Modified
    • application/problem+json content type Modified
      • type, title, detail, instance properties Modified
        • Type went from string | null to string
          Breaking
      • status property Modified
        • Type went from integer(int32) | null to integer(int32)
          Breaking
  • Authentication
  • Http bearer token authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • Adra personal access token authentication method Added
GET /api/v1.0/organizations/{organizationGuid}/auth-logs
  • Response
  • 200 response Modified
    • application/json content type Modified
      • continuationToken property Modified
        • Property is now required
          Breaking
        • Type went from string | null to null | string
      • responseData property Modified
        • Property is now required
          Breaking
        • Type went from array[object] | null to null | array[object]
        • id, organizationId, operatorId, authEvent, authAction, timestamp properties Modified
          • Properties are now required
            Breaking
        • unknownSub, ipAddress, logLevel properties Modified
          • Properties are now required
            Breaking
          • Type went from string | null to null | string
        • attributes property Modified
          • Property is now required
            Breaking
          • Type went from object | null to null | object
        • message property Modified
          • Property is now required
            Breaking
          • Type went from object to object | null
      • hasMoreChanges property Modified
        • Property is now required
          Breaking
  • 400 response Modified
    • application/problem+json content type Modified
      • type, title, detail, instance properties Modified
        • Type went from string | null to string
          Breaking
      • status property Modified
        • Type went from integer(int32) | null to integer(int32)
          Breaking
  • 401 response Modified
    • application/problem+json content type Modified
      • type, title, detail, instance properties Modified
        • Type went from string | null to string
          Breaking
      • status property Modified
        • Type went from integer(int32) | null to integer(int32)
          Breaking
  • 403 response Modified
    • application/problem+json content type Modified
      • type, title, detail, instance properties Modified
        • Type went from string | null to string
          Breaking
      • status property Modified
        • Type went from integer(int32) | null to integer(int32)
          Breaking
  • 404 response Modified
    • application/problem+json content type Modified
      • type, title, detail, instance properties Modified
        • Type went from string | null to string
          Breaking
      • status property Modified
        • Type went from integer(int32) | null to integer(int32)
          Breaking
  • default response Modified
    • application/problem+json content type Modified
      • type, title, detail, instance properties Modified
        • Type went from string | null to string
          Breaking
      • status property Modified
        • Type went from integer(int32) | null to integer(int32)
          Breaking
  • Authentication
  • Http bearer token authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • Adra personal access token authentication method Added
GET /api/v1.0/organizations/{organizationGuid}/auth-logs/status
  • Response
  • 200 response Modified
    • application/json content type Modified
      • hasMoreChanges property Modified
        • Property is now required
          Breaking
      • continuationToken property Modified
        • Property is now required
          Breaking
        • Type went from string | null to null | string
  • 400 response Modified
    • application/problem+json content type Modified
      • type, title, detail, instance properties Modified
        • Type went from string | null to string
          Breaking
      • status property Modified
        • Type went from integer(int32) | null to integer(int32)
          Breaking
  • 401 response Modified
    • application/problem+json content type Modified
      • type, title, detail, instance properties Modified
        • Type went from string | null to string
          Breaking
      • status property Modified
        • Type went from integer(int32) | null to integer(int32)
          Breaking
  • 403 response Modified
    • application/problem+json content type Modified
      • type, title, detail, instance properties Modified
        • Type went from string | null to string
          Breaking
      • status property Modified
        • Type went from integer(int32) | null to integer(int32)
          Breaking
  • 404 response Modified
    • application/problem+json content type Modified
      • type, title, detail, instance properties Modified
        • Type went from string | null to string
          Breaking
      • status property Modified
        • Type went from integer(int32) | null to integer(int32)
          Breaking
  • default response Modified
    • application/problem+json content type Modified
      • type, title, detail, instance properties Modified
        • Type went from string | null to string
          Breaking
      • status property Modified
        • Type went from integer(int32) | null to integer(int32)
          Breaking
  • Authentication
  • Http bearer token authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • Adra personal access token authentication method Added
Removed 1 Breaking
Http bearer tokenauthentication method
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
Added 1
Adra personal access tokenauthentication method