Read Validate Access Record

GET 
/config/data-space/validate-access-record/:validateAccessRecordId

Reads a specific Validate Access Record.

Request

Path Parameters

validateAccessRecordId stringrequired

ID of the Validate Access Record

Responses

200

Validate Access Record read

Response Headers

• Content-Type json

  Content-Type header

application/json

Schema

Schema

validateAccessRecord object

Record of an access token validation and authorisation attempt

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

Example (from schema)

{
  "validateAccessRecord": {
    "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
  }
}

Loading...