Consent APIs

Provides access to consent and privacy operations.

Retrieve active user consents for current user.

get

This endpoint returns all active and available consents associated with the current user. It provides visibility into the user's consent status, allowing them to understand their privacy options. This information is crucial for managing consent preferences and ensuring compliance with privacy regulations.

👤 User Credential: You must login and authenticate a user and use their access token to invoke this service. This will operate the action under the specified user.

🔒 Consent: consent.read is required in order for the call to succeed. Ensure that you have the consent approval for the user or this call will fail.

Authorizations

authorizationCode

OAuth2clientCredentialsRequired

An OIDC service account that was authenticated.

Authorization URL: Token URL:

Responses

200

The consent scopes available

application/json

401

Unauthorized

*/*

get

/consent/me

HTTPcURLJavaScriptPython

GET /consent/me HTTP/1.1
Host: gateway.dev.klustr.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

[
  {
    "id": "text",
    "org_id": "text",
    "project_id": "text",
    "app_id": "text",
    "subject_id": "text",
    "client_id": "text",
    "session_id": "text",
    "timestamp": "2025-12-16T22:08:02.699Z",
    "last_seen_date": "2025-12-16T22:08:02.699Z",
    "first_seen_date": "2025-12-16T22:08:02.699Z",
    "impressions": 1,
    "scopes": [
      {
        "id": "text",
        "status": "active",
        "consent_method": "implicit",
        "date_created": "2025-12-16T22:08:02.699Z",
        "date_revoked": "2025-12-16T22:08:02.699Z",
        "date_modified": "2025-12-16T22:08:02.699Z"
      }
    ],
    "agent": {
      "os": {
        "name": "text",
        "short_name": "text",
        "version": "text",
        "platform": "text",
        "family": "text"
      },
      "client": {
        "name": "text",
        "short_name": "text",
        "version": "text",
        "engine": "text",
        "engine_version": "text",
        "family": "text"
      },
      "device": {
        "id": "text",
        "type": "text",
        "brand": "text",
        "model": "text",
        "code": "text",
        "trusted": "text"
      },
      "header": "text"
    },
    "ip": "text"
  }
]

Retrieve user's privacy agreements and settings

get

This endpoint allows users to access their registered privacy agreements and opt-in settings. It ensures compliance with GDPR and digital conformance requirements. The information retrieved is specific to the authenticated user's identity.

👤 User Credential: You must login and authenticate a user and use their access token to invoke this service. This will operate the action under the specified user.

Authorizations

authorizationCode

OAuth2clientCredentialsRequired

An OIDC service account that was authenticated.

Authorization URL: Token URL:

Responses

200

OK

*/*

401

Unauthorized

*/*

get

/consent/me/agreements

HTTPcURLJavaScriptPython

GET /consent/me/agreements HTTP/1.1
Host: gateway.dev.klustr.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "orgs": {
    "ANY_ADDITIONAL_PROPERTY": {
      "id": "text",
      "name": "text"
    }
  },
  "agreements": [
    {
      "org_id": "text",
      "agreement_id": "text",
      "version_number": "text",
      "first_seen_date": "2025-12-16T22:08:02.699Z",
      "last_seen_date": "2025-12-16T22:08:02.699Z",
      "status": "active",
      "id": "text",
      "subject_id": "text",
      "scopes": [
        {
          "id": "text",
          "status": "active",
          "consent_method": "implicit",
          "date_created": "2025-12-16T22:08:02.699Z",
          "date_revoked": "2025-12-16T22:08:02.699Z",
          "date_modified": "2025-12-16T22:08:02.699Z"
        }
      ]
    }
  ],
  "details": {
    "ANY_ADDITIONAL_PROPERTY": {
      "id": "text",
      "name": "text",
      "org_id": "text",
      "namespace": "org",
      "object_id": "org",
      "description": "text",
      "versions": [
        {
          "id": "text",
          "version_number": "text",
          "version_type": "minor",
          "modified_date": "2025-12-16T22:08:02.699Z",
          "effective_date": "2025-12-16T22:08:02.699Z",
          "scopes": [
            {
              "id": "text",
              "sensitivity": "text",
              "purpose": [
                "COLLECTION"
              ]
            }
          ],
          "content": [
            {
              "url": "text",
              "title": "text",
              "locale": "text",
              "mime_type": "text",
              "date_created": "2025-12-16T22:08:02.699Z",
              "date_modified": "2025-12-16T22:08:02.699Z"
            }
          ],
          "status": "draft"
        }
      ],
      "status": "test",
      "type": "privacy_policy",
      "date_created": "2025-12-16T22:08:02.699Z",
      "date_modified": "2025-12-16T22:08:02.699Z",
      "owner": {
        "email": "text"
      }
    }
  }
}

Add a user agreement to history

post

This endpoint allows users to add an agreement to their history of accepted privacy agreements. It ensures compliance with GDPR and other privacy regulations. The operation is intended for individual users managing their consent preferences.

👤 User Credential: You must login and authenticate a user and use their access token to invoke this service. This will operate the action under the specified user.

Authorizations

authorizationCode

OAuth2clientCredentialsRequired

An OIDC service account that was authenticated.

Authorization URL: Token URL:

Path parameters

organizationIdstringRequired

agreementIdstringRequired

Responses

200

OK

401

Unauthorized

*/*

post

/consent/me/agreements/{organizationId}/agreements/{agreementId}

HTTPcURLJavaScriptPython

POST /consent/me/agreements/{organizationId}/agreements/{agreementId} HTTP/1.1
Host: gateway.dev.klustr.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

No content

Delete a user's agreement record

delete

This endpoint allows the deletion of a specific agreement associated with a user. It ensures that the user's privacy preferences are updated accordingly. Use this operation to manage user consent and compliance with GDPRC regulations effectively.

👤 User Credential: You must login and authenticate a user and use their access token to invoke this service. This will operate the action under the specified user.

Authorizations

authorizationCode

OAuth2clientCredentialsRequired

An OIDC service account that was authenticated.

Authorization URL: Token URL:

Path parameters

organizationIdstringRequired

agreementIdstringRequired

Responses

200

OK

401

Unauthorized

*/*

delete

/consent/me/agreements/{organizationId}/agreements/{agreementId}

HTTPcURLJavaScriptPython

DELETE /consent/me/agreements/{organizationId}/agreements/{agreementId} HTTP/1.1
Host: gateway.dev.klustr.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

No content

Retrieve user's consent for a specific application

get

Fetches the current consent status for the specified application. This includes details such as the last update time and the last access time. It ensures users have control over their consent and privacy preferences.

👤 User Credential: You must login and authenticate a user and use their access token to invoke this service. This will operate the action under the specified user.

🔒 Consent: consent.read is required in order for the call to succeed. Ensure that you have the consent approval for the user or this call will fail.

Authorizations

authorizationCode

OAuth2clientCredentialsRequired

An OIDC service account that was authenticated.

Authorization URL: Token URL:

Path parameters

appIdstringRequired

Responses

200

OK

*/*

401

Unauthorized

*/*

get

/consent/me/apps/{appId}

HTTPcURLJavaScriptPython

GET /consent/me/apps/{appId} HTTP/1.1
Host: gateway.dev.klustr.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "id": "text",
  "org_id": "text",
  "project_id": "text",
  "app_id": "text",
  "subject_id": "text",
  "client_id": "text",
  "session_id": "text",
  "timestamp": "2025-12-16T22:08:02.699Z",
  "last_seen_date": "2025-12-16T22:08:02.699Z",
  "first_seen_date": "2025-12-16T22:08:02.699Z",
  "impressions": 1,
  "scopes": [
    {
      "id": "text",
      "status": "active",
      "consent_method": "implicit",
      "date_created": "2025-12-16T22:08:02.699Z",
      "date_revoked": "2025-12-16T22:08:02.699Z",
      "date_modified": "2025-12-16T22:08:02.699Z"
    }
  ],
  "agent": {
    "os": {
      "name": "text",
      "short_name": "text",
      "version": "text",
      "platform": "text",
      "family": "text"
    },
    "client": {
      "name": "text",
      "short_name": "text",
      "version": "text",
      "engine": "text",
      "engine_version": "text",
      "family": "text"
    },
    "device": {
      "id": "text",
      "type": "text",
      "brand": "text",
      "model": "text",
      "code": "text",
      "trusted": "text"
    },
    "header": "text"
  },
  "ip": "text"
}

Revoke user consent for a specific application

delete

This endpoint allows users to revoke their granted consent for an application. It invalidates all associated OAuth 2.0 Access Tokens, requiring the user to sign in again. This action enhances user privacy and control over their consent preferences.

👤 User Credential: You must login and authenticate a user and use their access token to invoke this service. This will operate the action under the specified user.

🔒 Consent: consent.update is required in order for the call to succeed. Ensure that you have the consent approval for the user or this call will fail.

Authorizations

authorizationCode

OAuth2clientCredentialsRequired

An OIDC service account that was authenticated.

Authorization URL: Token URL:

Path parameters

appIdstringRequired

Responses

200

OK

401

Unauthorized

*/*

delete

/consent/me/apps/{appId}

HTTPcURLJavaScriptPython

DELETE /consent/me/apps/{appId} HTTP/1.1
Host: gateway.dev.klustr.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

No content

Revoke specific user consent for an application

delete

This endpoint allows users to selectively revoke consent for specific scopes associated with an application. By doing so, users can maintain certain consents while removing others, enhancing their control over privacy and consent management.

👤 User Credential: You must login and authenticate a user and use their access token to invoke this service. This will operate the action under the specified user.

🔒 Consent: consent.update is required in order for the call to succeed. Ensure that you have the consent approval for the user or this call will fail.

Authorizations

authorizationCode

OAuth2clientCredentialsRequired

An OIDC service account that was authenticated.

Authorization URL: Token URL:

Path parameters

appIdstringRequired

scopestringRequired

Responses

200

OK

401

Unauthorized

*/*

delete

/consent/me/apps/{appId}/scopes/{scope}

HTTPcURLJavaScriptPython

DELETE /consent/me/apps/{appId}/scopes/{scope} HTTP/1.1
Host: gateway.dev.klustr.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

No content

Revoke user consent for a specific experiment.

delete

This endpoint allows users to revoke their consent for a specific experiment. It ensures that any prior consent is invalidated, along with all associated access and refresh tokens. This operation is crucial for maintaining user privacy and control over personal data.

👤 User Credential: You must login and authenticate a user and use their access token to invoke this service. This will operate the action under the specified user.

🔒 Consent: consent.update is required in order for the call to succeed. Ensure that you have the consent approval for the user or this call will fail.

Authorizations

authorizationCode

OAuth2clientCredentialsRequired

An OIDC service account that was authenticated.

Authorization URL: Token URL:

Path parameters

experimentIdstringRequired

Query parameters

client_idanyRequired

The client ID to perform the consent operation against.

experiment_idanyRequired

The experiment ID to perform the consent operation against.

Responses

200

OK

401

Unauthorized

*/*

delete

/consent/me/experiments/{experimentId}

HTTPcURLJavaScriptPython

DELETE /consent/me/experiments/{experimentId} HTTP/1.1
Host: gateway.dev.klustr.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

No content