Fetches audit history based on query parameters

GET /audit
O auth

Headers

  • x-fapi-auth-date string

    The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC

    Format should match the following pattern: ^(Mon|Tue|Wed|Thu|Fri|Sat|Sun), \d{2} (Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sep|Oct|Nov|Dec) \d{4} \d{2}:\d{2}:\d{2} (GMT|UTC)$.

  • x-fapi-customer-ip-address string

    The PSU's IP address if the PSU is currently logged in with the TPP.

  • x-fapi-interaction-id string

    An RFC4122 UID used as a correlation id.

  • x-customer-user-agent string

    Indicates the user-agent that the PSU is using.

Query parameters

  • actionType string

    The type of action to search for.

    Values are created, updated, or deleted.

  • organisationId string

    The organisation ID

    Minimum length is 1, maximum length is 40. Format should match the following pattern: ^[^<>]*$.

  • resourceType string

    The type of resource to search for.

    Values are apiResource, apiDiscoveryEndpoint, authorisationServer, authorisationServerCertification, certificationManager, contact, organisation, organisationCertificate, organisationAdmin, organisationAuthorityClaim, organisationAuthorityClaimAuthorisations, organisationAuthorityDomainClaim, organisationAuthorityDomainClaimUser, organisationTermsAndConditions, softwareStatement, softwareStatementAuthorityRoleClaim, softwareStatementCertificate, softwareStatementCertification, referenceAuthorisationDomain, referenceAuthorisationDomainRole, referenceAuthorisationDomainRoleMetadata, referenceAuthority, referenceAuthorityAuthorisationDomain, referenceTermsAndConditions, federation, federationMetadataPolicy, superUser, or flag.

  • resourceId string

    The ID of the specific resource we want to parse by.

  • performedBy string

    The user email you want to parse by. This will be performed for createdBy and updatedBy based on the revision type

  • startDate string(date-time)

    Optional start of date range to constrain the set of results returned. This will restrict the clients returned to those whose metadata was most recently modified after the specified startDate. The date must be supplied in RFC3339 format. If not supplied, the startDate used will be the epoch.

  • endDate string(date-time)

    Optional end of date range to constrain the set of results returned. This will restrict the clients returned to those whose metadata was most recently modified before the specified sendDate. The date must be supplied in RFC3339 format. If not supplied, the endDate used will be the current date and time.

  • page integer

    The page number to return of the result set

  • size integer

    The size of the pages to return

  • sort string

    The field name to sort

Responses

  • 200 application/json

    Audit history in paginated form

    Hide headers attribute Show headers attribute
    • x-fapi-interaction-id string

      An RFC4122 UID used as a correlation id.

      Minimum length is 1, maximum length is 100. Format should match the following pattern: ^[a-zA-Z0-9][a-zA-Z0-9\-]{0,99}$.

    Hide response attributes Show response attributes object
    • items array[object]
      Any of:
      OrganisationAuthorityClaimDetailsAudit object SoftwareStatementAudit object
    • empty boolean
    • numberOfElements integer
    • offset integer
    • pageNumber integer
    • pageable object
      Hide pageable attributes Show pageable attributes object
      • number integer

        Page number

      • offset integer

        Offset

      • size integer

        Size of the page

      • sort object
        Hide sort attributes Show sort attributes object
        • orderBy array[object]
          Hide orderBy attributes Show orderBy attributes object
          • ascending boolean

            Whether ascending

          • direction string

            Direction of sort, i.e. ascending or descending

            Values are ASC or DESC.

          • ignoreCase boolean

            Was the case ignored

          • property string

            Name of the property used for sorting

        • sorted boolean
      • sorted boolean

        Is the page sorted

      • unpaged boolean

        Is this an unpaged response

    • size integer
    • totalPages integer
    • totalSize integer
  • 400 application/json

    Bad Request

    Hide headers attribute Show headers attribute
    • x-fapi-interaction-id string

      An RFC4122 UID used as a correlation id.

      Minimum length is 1, maximum length is 100. Format should match the following pattern: ^[a-zA-Z0-9][a-zA-Z0-9\-]{0,99}$.

    Hide response attribute Show response attribute object
    • errors array[string]

      Validation Error messages
  • 401

    Unauthorized

    Hide headers attribute Show headers attribute
    • x-fapi-interaction-id string

      An RFC4122 UID used as a correlation id.

      Minimum length is 1, maximum length is 100. Format should match the following pattern: ^[a-zA-Z0-9][a-zA-Z0-9\-]{0,99}$.

  • 403

    Forbidden

    Hide headers attribute Show headers attribute
    • x-fapi-interaction-id string

      An RFC4122 UID used as a correlation id.

      Minimum length is 1, maximum length is 100. Format should match the following pattern: ^[a-zA-Z0-9][a-zA-Z0-9\-]{0,99}$.

  • 404 application/json

    Not found

    Hide headers attribute Show headers attribute
    • x-fapi-interaction-id string

      An RFC4122 UID used as a correlation id.

      Minimum length is 1, maximum length is 100. Format should match the following pattern: ^[a-zA-Z0-9][a-zA-Z0-9\-]{0,99}$.

    Hide response attribute Show response attribute object
    • errors array[string]

      Validation Error messages
  • 429

    Too many requests, maximum capacity reached. Requests are now throttled.

    Hide headers attribute Show headers attribute
    • x-fapi-interaction-id string

      An RFC4122 UID used as a correlation id.

      Minimum length is 1, maximum length is 100. Format should match the following pattern: ^[a-zA-Z0-9][a-zA-Z0-9\-]{0,99}$.

  • 500

    Internal Server Error

    Hide headers attribute Show headers attribute
    • x-fapi-interaction-id string

      An RFC4122 UID used as a correlation id.

      Minimum length is 1, maximum length is 100. Format should match the following pattern: ^[a-zA-Z0-9][a-zA-Z0-9\-]{0,99}$.

  • 501 application/json

    Request is not yet implemented

    Hide headers attribute Show headers attribute
    • x-fapi-interaction-id string

      An RFC4122 UID used as a correlation id.

      Minimum length is 1, maximum length is 100. Format should match the following pattern: ^[a-zA-Z0-9][a-zA-Z0-9\-]{0,99}$.

    Hide response attribute Show response attribute object
    • errors array[string]

      Validation Error messages
  • 502

    Bad Gateway

    Hide headers attribute Show headers attribute
    • x-fapi-interaction-id string

      An RFC4122 UID used as a correlation id.

      Minimum length is 1, maximum length is 100. Format should match the following pattern: ^[a-zA-Z0-9][a-zA-Z0-9\-]{0,99}$.

  • 504

    Upstream timeout, insufficient capacity to serve request. More capacity being brought online. Please try again.

    Hide headers attribute Show headers attribute
    • x-fapi-interaction-id string

      An RFC4122 UID used as a correlation id.

      Minimum length is 1, maximum length is 100. Format should match the following pattern: ^[a-zA-Z0-9][a-zA-Z0-9\-]{0,99}$.

GET /audit 
curl \
 --request GET 'https://matls-api.sandbox.raidiam.io/audit' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "x-fapi-auth-date: string" \
 --header "x-fapi-customer-ip-address: string" \
 --header "x-fapi-interaction-id: string" \
 --header "x-customer-user-agent: string"
Response examples (200) 
# Headers
x-fapi-interaction-id: 73cac523-d3ae-2289-b106-330a6218710d

# Payload
{
  "items": [
    {
      "EntryId": 42,
      "EntryType": "created",
      "PerformedBy": "string",
      "ResourceType": "apiResource",
      "Timestamp": "2025-05-04",
      "AuthorisationDomain": "string",
      "AuthorisationDomainRoleIdentifier": "string",
      "AuthorityId": "string",
      "OrganisationAuthorityClaimId": "string",
      "OrganisationId": "string",
      "RegistrationId": "string",
      "Role": "PAGTO",
      "Status": "Active",
      "UniqueTechnicalIdenifier": [
        "string"
      ],
      "UniqueTechnicalIdentifiers": [
        "string"
      ]
    }
  ],
  "empty": true,
  "numberOfElements": 42,
  "offset": 42,
  "pageNumber": 42,
  "pageable": {
    "number": 42,
    "offset": 42,
    "size": 42,
    "sort": {
      "orderBy": [
        {
          "ascending": true,
          "direction": "ASC",
          "ignoreCase": true,
          "property": "createdAt"
        }
      ],
      "sorted": true
    },
    "sorted": true,
    "unpaged": true
  },
  "size": 42,
  "totalPages": 42,
  "totalSize": 42
}
Response examples (400) 
# Headers
x-fapi-interaction-id: 73cac523-d3ae-2289-b106-330a6218710d

# Payload
{
  "errors": [
    "string"
  ]
}
Response examples (404) 
# Headers
x-fapi-interaction-id: 73cac523-d3ae-2289-b106-330a6218710d

# Payload
{
  "errors": [
    "string"
  ]
}
Response examples (501) 
# Headers
x-fapi-interaction-id: 73cac523-d3ae-2289-b106-330a6218710d

# Payload
{
  "errors": [
    "string"
  ]
}