List Validate Access Records

GET 
/config/data-space/validate-access-records

Lists Validate Access Records which show every time an access token was checked at the token verification and authorisation endpoint (validate access).

Request

Query Parameters

offset integerrequired

Requested index for start of resources to be provided in response requested by client

limit integerrequired

Default value: 10

Number of items returned per page. Requested number of resources to be provided in response requested by client.

Responses

200

Validate Access Records listed

Response Headers

• Content-Type json

  Content-Type header

application/json

Schema

Schema

validateAccessRecords object[]
Array [
id stringrequired
Unique identifier for the validation record
requestedDataDisclosureAgreementRecordId stringrequired
ID of the Data Disclosure Agreement Record connected to the access token
requestedDataClassification stringrequired
Possible values: [pii, anonymous]
Data classification requested (e.g., "pii", "anonymous") in the access token
requestedExternalIdType string
Type of external ID requested (only for PII classification)
requestedExternalId string
External ID value requested (only for PII classification)
connectedAgreementIds objectrequired
Holds the specific revision ID for the record connected to the access token, as well as the connected Data Disclosure Agreement Template Revision ID and the underlying Data Agreement Revision ID.
dataDisclosureAgreementRecordRevisionId string
ID of the specific Data Disclosure Agreement Record Revision the token was released for
dataDisclosureAgreementTemplateRevisionId string
ID of the specific Data Disclosure Agreement Template Revision that the record was signed for
dataAgreementRevisionId string
ID of the underlying Data Agreement Revision that defines the data to be shared between the Data Source and Data Using Service
request objectrequired
The original validation request
accessToken stringrequired
The JWT Access Token that was validated
httpMethod stringrequired
The HTTP method that was requested
path stringrequired
The API path that was requested
response object required
The validation response (success or failure)
oneOf
MOD1
verified booleanrequired
Possible values: [true]
Whether the access token was verified and authorized
dataClassification stringrequired
Possible values: [pii, anonymous]
Data classification of the validated access
individuals object[]required
List of individuals associated with this access
decodedClaims objectrequired
The decoded JWT claims. The fields listed below will be present; additional claims are allowed.
aud stringrequired
The audience of the JWT
dataClassification stringrequired
Possible values: [anonymous, pii]
The data classification of the requested resource
dataDisclosureAgreementRecordId stringrequired
The ID of the Data Disclosure Agreement Record associated with this token
exp integerrequired
The expiration time of the JWT
iat integerrequired
The issued at time of the JWT
iss stringrequired
The issuer of the JWT
jti stringrequired
The unique identifier for the JWT
property name* any
The decoded JWT claims. The fields listed below will be present; additional claims are allowed.
MOD2
verified booleanrequired
Possible values: [false]
Whether the access token was verified and authorized
reason stringrequired
The reason why validation failed
timestamp int64required
Unix timestamp when the validation occurred
]
pagination object

currentPage integer

Current page number

totalItems integer

Total number of items available

totalPages integer

Total number of pages based on limit

limit integer

Number of items per page

hasPrevious boolean

Indicates if there's a previous page

hasNext boolean

Indicates if there's a next page

Example (from schema)

{
  "validateAccessRecords": [
    {
      "id": "string",
      "requestedDataDisclosureAgreementRecordId": "string",
      "requestedDataClassification": "pii",
      "requestedExternalIdType": "string",
      "requestedExternalId": "string",
      "connectedAgreementIds": {
        "dataDisclosureAgreementRecordRevisionId": "string",
        "dataDisclosureAgreementTemplateRevisionId": "string",
        "dataAgreementRevisionId": "string"
      },
      "request": {
        "accessToken": "string",
        "httpMethod": "string",
        "path": "string"
      },
      "response": {},
      "timestamp": 0
    }
  ],
  "pagination": {
    "currentPage": 0,
    "totalItems": 0,
    "totalPages": 0,
    "limit": 0,
    "hasPrevious": true,
    "hasNext": true
  }
}

Loading...