Skip to main content

Fetches audit history based on query parameters

GET 
/audit

Fetches audit history and parses based on query parameters

Request​

Query Parameters

    actionType ActionType

    Possible values: [created, updated, deleted]

    The type of action to search for.

    OrganisationIdQueryParameter OrganisationId

    Possible values: non-empty and <= 40 characters, Value must match regular expression ^[^<>]*$

    The organisation ID

    resourceType ResourceType

    Possible values: [apiResource, apiDiscoveryEndpoint, authorisationServer, authorisationServerCertification, certificationManager, contact, organisation, organisationCertificate, organisationAdmin, organisationAuthorityClaim, organisationAuthorityClaimAuthorisations, organisationAuthorityDomainClaim, organisationAuthorityDomainClaimUser, organisationTermsAndConditions, softwareStatement, softwareStatementAuthorityRoleClaim, softwareStatementCertificate, softwareStatementCertification, referenceAuthorisationDomain, referenceAuthorisationDomainRole, referenceAuthorisationDomainRoleMetadata, referenceAuthority, referenceAuthorityAuthorisationDomain, referenceTermsAndConditions, superUser]

    The type of resource to search for.

    Example: apiResource
    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 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.

    Example: 2022-05-12T23:20:50Z
    endDate 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.

    Example: 2022-05-15T23:20:50Z
    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

Header Parameters

    x-fapi-auth-date string

    Possible values: Value must match regular expression ^(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)$

    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

    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.

Responses​

Audit history in paginated form

Response Headers

  • x-fapi-interaction-id

    string

Schema

    items

    object[]

  • Array [

    • anyOf

    ResourceType ResourceType (string)

    Possible values: [apiResource, apiDiscoveryEndpoint, authorisationServer, authorisationServerCertification, certificationManager, contact, organisation, organisationCertificate, organisationAdmin, organisationAuthorityClaim, organisationAuthorityClaimAuthorisations, organisationAuthorityDomainClaim, organisationAuthorityDomainClaimUser, organisationTermsAndConditions, softwareStatement, softwareStatementAuthorityRoleClaim, softwareStatementCertificate, softwareStatementCertification, referenceAuthorisationDomain, referenceAuthorisationDomainRole, referenceAuthorisationDomainRoleMetadata, referenceAuthority, referenceAuthorityAuthorisationDomain, referenceTermsAndConditions, superUser]

    EntryType ActionType (string)

    Possible values: [created, updated, deleted]

    PerformedBy string

    The user who performed the action

    Timestamp date

    When the action was performed

    EntryId integer

    The unique ID of the action

    OrganisationId OrganisationId (string)

    Possible values: non-empty and <= 40 characters, Value must match regular expression ^[^<>]*$

    Unique ID associated with the organisation

    OrganisationAuthorityClaimId OrganisationAuthorityClaimId (string)

    Possible values: non-empty and <= 40 characters, Value must match regular expression ^[^<>]*$

    Unique ID associated with the authority claims

    AuthorityId AuthorityId (string)

    Possible values: non-empty and <= 40 characters, Value must match regular expression ^[^<>]*$

    Unique ID associated with the Authorisation reference schema

    Status StatusEnum (string)

    Possible values: [Active, Inactive]

    Default value: Active

    Current status of this resource

    AuthorisationDomain string

    Possible values: <= 30 characters, Value must match regular expression ^[^<>]*$

    Authorisation Domain for the authority

    Role AuthorisationDomainRoleName (string)

    Possible values: non-empty and <= 60 characters, Value must match regular expression ^[^<>]*$

    The authorisation domain role name

    RegistrationId string

    Possible values: <= 40 characters, Value must match regular expression ^[^<>]*$

    Registration ID for the organisation

    UniqueTechnicalIdenifier string[]deprecated

    Possible values: <= 255 characters, Value must match regular expression ^[^<>]*$

    Legacy and will eventually be removed - please use UniqueTechnicalIdentifiers instead

    UniqueTechnicalIdentifiers UniqueTechnicalIdentifier (string)[]

    Possible values: <= 16

  • ]

    • totalPages integer
    totalSize integer

    pageable

    object

    number integer

    Page number

    sort

    object

    sorted boolean

    orderBy

    object[]

  • Array [

    • property string

    Name of the property used for sorting

    direction string

    Possible values: [ASC, DESC]

    Direction of sort, i.e. ascending or descending

    ignoreCase boolean

    Was the case ignored

    ascending boolean

    Whether ascending

  • ]

    • size integer

    Size of the page

    offset integer

    Offset

    sorted boolean

    Is the page sorted

    unpaged boolean

    Is this an unpaged response

    numberOfElements integer
    size integer
    offset integer
    empty boolean
    pageNumber integer
Loading...