Consent Admin APIs

Provides access to consent and privacy operations.

Audit user consent for administrative oversight

post

This endpoint allows administrators to audit and track user consent grants. It provides a comprehensive view of consent status by consolidating related agreements and hierarchies. This functionality is essential for maintaining compliance and understanding user preferences in real-time.

💻 Service Credentials is required to access this service.

Authorizations

clientCredentials

OAuth2authorizationCodeRequired

An OIDC service account that was authenticated.

Token URL:

Body

application/json

idstringOptional

subject_idstringOptional

org_idstringOptional

project_idstringOptional

app_idstringOptional

client_idstringOptional

session_idstringOptional

timestampstring · date-timeOptional

skippedbooleanOptional

scopesstring[]Optional

experimentsstring[]Optional

ipstringOptional

Responses

200

OK

No content

401

Unauthorized

*/*

post

/consent/admin/audit

HTTPcURLJavaScriptPython

POST /consent/admin/audit HTTP/1.1
Host: gateway.dev.klustr.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 565

{
  "id": "text",
  "subject_id": "text",
  "org_id": "text",
  "project_id": "text",
  "app_id": "text",
  "client_id": "text",
  "session_id": "text",
  "timestamp": "2025-12-16T22:16:33.600Z",
  "skipped": true,
  "scopes": [
    "text"
  ],
  "experiments": [
    "text"
  ],
  "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"
}

No content

Retrieve current user consent scopes for admin.

post

This endpoint allows administrators to access the active consent scopes granted by users. It consolidates all relevant consent information, ensuring a comprehensive view of user permissions at the present time. This is essential for auditing and compliance purposes.

💻 Service Credentials is required to access this service.

🔒 Permission: user.consent.get is required in order for the call to succeed. You must configure permissions for the person or service calling this endpoint and add this permission to their identity.

Authorizations

clientCredentials

OAuth2authorizationCodeRequired

An OIDC service account that was authenticated.

Token URL:

Body

application/json

subject_idstringOptional

client_idstringOptional

Responses

200

OK

*/*

401

Unauthorized

*/*

post

/consent/admin/scopes

HTTPcURLJavaScriptPython

POST /consent/admin/scopes HTTP/1.1
Host: gateway.dev.klustr.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 40

{
  "subject_id": "text",
  "client_id": "text"
}

{
  "scopes": [
    "text"
  ],
  "experiments": [
    "text"
  ]
}

Retrieve all consents for a specified user.

get

This endpoint allows administrators to access and list all consent records associated with a specific user. It is intended for auditing purposes and ensures that consent management is transparent and compliant with privacy regulations.

💻 Service Credentials is required to access this service.

🔒 Permission: user.consent.get is required in order for the call to succeed. You must configure permissions for the person or service calling this endpoint and add this permission to their identity.

Authorizations

clientCredentials

OAuth2authorizationCodeRequired

An OIDC service account that was authenticated.

Token URL:

Path parameters

userIdstringRequired

Responses

200

OK

*/*

401

Unauthorized

*/*

get

/consent/admin/{userId}

HTTPcURLJavaScriptPython

GET /consent/admin/{userId} HTTP/1.1
Host: gateway.dev.klustr.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "user_id": "text",
  "empty": true,
  "orgs": [
    {
      "org_id": "text",
      "org_name": "text",
      "scopes": [
        {
          "id": "text",
          "status": "active",
          "consent_method": "implicit",
          "date_created": "2025-12-16T22:16:33.600Z",
          "date_revoked": "2025-12-16T22:16:33.600Z",
          "date_modified": "2025-12-16T22:16:33.600Z"
        }
      ],
      "apps": [
        {
          "app_id": "text",
          "app_name": "text",
          "app_logo": "https://example.com",
          "scopes": [
            {
              "id": "text",
              "status": "active",
              "consent_method": "implicit",
              "date_created": "2025-12-16T22:16:33.600Z",
              "date_revoked": "2025-12-16T22:16:33.600Z",
              "date_modified": "2025-12-16T22:16:33.600Z"
            }
          ],
          "experiments": [
            {
              "experiment_id": "text",
              "experiment_name": "text",
              "scopes": [
                {
                  "id": "text",
                  "status": "active",
                  "consent_method": "implicit",
                  "date_created": "2025-12-16T22:16:33.600Z",
                  "date_revoked": "2025-12-16T22:16:33.600Z",
                  "date_modified": "2025-12-16T22:16:33.600Z"
                }
              ]
            }
          ]
        }
      ],
      "agreements": [
        {
          "agreement_id": "text",
          "agreement_name": "text",
          "scopes": [
            {
              "id": "text",
              "status": "active",
              "consent_method": "implicit",
              "date_created": "2025-12-16T22:16:33.600Z",
              "date_revoked": "2025-12-16T22:16:33.600Z",
              "date_modified": "2025-12-16T22:16:33.600Z"
            }
          ]
        }
      ]
    }
  ]
}

Retrieve user agreements for admin access

get

This endpoint allows administrators to retrieve the user agreements associated with a specific user. It provides essential information regarding the user's privacy agreements and consent settings, ensuring compliance with GDPR and digital conformance requirements.

💻 Service Credentials is required to access this service.

🔒 Permission: user.consent.list is required in order for the call to succeed. You must configure permissions for the person or service calling this endpoint and add this permission to their identity.

Authorizations

clientCredentials

OAuth2authorizationCodeRequired

An OIDC service account that was authenticated.

Token URL:

Path parameters

userIdstringRequired

Responses

200

OK

*/*

401

Unauthorized

*/*

get

/consent/admin/{userId}/agreements

HTTPcURLJavaScriptPython

GET /consent/admin/{userId}/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:16:33.600Z",
      "last_seen_date": "2025-12-16T22:16:33.600Z",
      "status": "active",
      "id": "text",
      "subject_id": "text",
      "scopes": [
        {
          "id": "text",
          "status": "active",
          "consent_method": "implicit",
          "date_created": "2025-12-16T22:16:33.600Z",
          "date_revoked": "2025-12-16T22:16:33.600Z",
          "date_modified": "2025-12-16T22:16:33.600Z"
        }
      ]
    }
  ],
  "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:16:33.600Z",
          "effective_date": "2025-12-16T22:16:33.600Z",
          "scopes": [
            {
              "id": "text",
              "sensitivity": "text",
              "purpose": [
                "COLLECTION"
              ]
            }
          ],
          "content": [
            {
              "url": "text",
              "title": "text",
              "locale": "text",
              "mime_type": "text",
              "date_created": "2025-12-16T22:16:33.600Z",
              "date_modified": "2025-12-16T22:16:33.600Z"
            }
          ],
          "status": "draft"
        }
      ],
      "status": "test",
      "type": "privacy_policy",
      "date_created": "2025-12-16T22:16:33.600Z",
      "date_modified": "2025-12-16T22:16:33.600Z",
      "owner": {
        "email": "text"
      }
    }
  }
}

Admin adds user agreement to history

post

This endpoint allows an admin to add a user agreement to the history of agreements made by a specific user. It ensures compliance with privacy regulations and tracks user consent effectively. Use this operation to maintain accurate records of user agreements for GDPR and digital conformance.

💻 Service Credentials is required to access this service.

🔒 Permission: user.consent.create is required in order for the call to succeed. You must configure permissions for the person or service calling this endpoint and add this permission to their identity.

Authorizations

clientCredentials

OAuth2authorizationCodeRequired

An OIDC service account that was authenticated.

Token URL:

Path parameters

userIdstringRequired

agreementIdstringRequired

Responses

200

OK

No content

401

Unauthorized

*/*

post

/consent/admin/{userId}/agreements/{agreementId}

HTTPcURLJavaScriptPython

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

No content

Admin delete a user's agreement record

delete

This endpoint allows an admin to delete a specific agreement associated with a user. It ensures that the user's privacy agreements are managed effectively, maintaining compliance with GDPRC regulations. Use this operation with caution, as it permanently removes the agreement from the user's profile.

💻 Service Credentials is required to access this service.

🔒 Permission: user.consent.delete is required in order for the call to succeed. You must configure permissions for the person or service calling this endpoint and add this permission to their identity.

Authorizations

clientCredentials

OAuth2authorizationCodeRequired

An OIDC service account that was authenticated.

Token URL:

Path parameters

userIdstringRequired

agreementIdstringRequired

Responses

200

OK

No content

401

Unauthorized

*/*

delete

/consent/admin/{userId}/agreements/{agreementId}

HTTPcURLJavaScriptPython

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

No content

Retrieve user consent for a specific application.

get

Fetches all consent records associated with the given user ID and application ID. This endpoint is intended for administrative use, allowing authorized personnel to audit user consents for compliance and privacy management.

💻 Service Credentials is required to access this service.

🔒 Permission: user.consent.get is required in order for the call to succeed. You must configure permissions for the person or service calling this endpoint and add this permission to their identity.

Authorizations

clientCredentials

OAuth2authorizationCodeRequired

An OIDC service account that was authenticated.

Token URL:

Path parameters

userIdstringRequired

appIdstringRequired

Responses

200

OK

*/*

401

Unauthorized

*/*

get

/consent/admin/{userId}/apps/{appId}

HTTPcURLJavaScriptPython

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

{
  "consent": {
    "id": "text",
    "org_id": "text",
    "project_id": "text",
    "app_id": "text",
    "subject_id": "text",
    "client_id": "text",
    "session_id": "text",
    "timestamp": "2025-12-16T22:16:33.600Z",
    "last_seen_date": "2025-12-16T22:16:33.600Z",
    "first_seen_date": "2025-12-16T22:16:33.600Z",
    "impressions": 1,
    "scopes": [
      {
        "id": "text",
        "status": "active",
        "consent_method": "implicit",
        "date_created": "2025-12-16T22:16:33.600Z",
        "date_revoked": "2025-12-16T22:16:33.600Z",
        "date_modified": "2025-12-16T22:16:33.600Z"
      }
    ],
    "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"
  },
  "experiments": [
    {
      "details": {
        "id": "text",
        "name": "text",
        "description": "text",
        "media": {
          "hero_image_url": "text"
        },
        "privacyUrl": "text",
        "infoUrl": "text",
        "tosUrl": "text",
        "start_date": "2025-12-16T22:16:33.600Z",
        "stop_date": "2025-12-16T22:16:33.600Z"
      },
      "consent": {
        "experiment_id": "text",
        "client_id": "text",
        "app_id": "text",
        "project_id": "text",
        "org_id": "text",
        "first_seen_date": "2025-12-16T22:16:33.600Z",
        "last_seen_date": "2025-12-16T22:16:33.600Z",
        "status": "active",
        "id": "text",
        "subject_id": "text",
        "scopes": [
          {
            "id": "text",
            "status": "active",
            "consent_method": "implicit",
            "date_created": "2025-12-16T22:16:33.600Z",
            "date_revoked": "2025-12-16T22:16:33.600Z",
            "date_modified": "2025-12-16T22:16:33.600Z"
          }
        ]
      }
    }
  ],
  "scopes": [
    {
      "scope": "text",
      "details": {
        "id": "text",
        "category": "text",
        "subcategory": "text",
        "label": {
          "en": "text",
          "jp": "text"
        },
        "org_id": "text",
        "status": "test",
        "description": {
          "en": "text",
          "jp": "text"
        },
        "sensitivity": "High",
        "visible": true
      }
    }
  ],
  "metadata": {
    "brand": {
      "name": "text",
      "logo": {
        "filename": "text",
        "url": "https://example.com"
      },
      "dark": {}
    },
    "links": {
      "home": "https://example.com",
      "privacy": "https://example.com",
      "tos": "https://example.com"
    },
    "contact": {
      "support_email": "text",
      "developer_emails": [
        "text"
      ]
    }
  },
  "first_seen_date": "2025-12-16T22:16:33.600Z",
  "last_seen_date": "2025-12-16T22:16:33.600Z"
}

Admin removes user consent for a specific application.

delete

This endpoint allows administrators to revoke consent granted by a user for a specific application. It ensures that all associated permissions are removed, enhancing user privacy and control over their data. Use this operation to manage user consents effectively.

💻 Service Credentials is required to access this service.

🔒 Permission: user.consent.delete is required in order for the call to succeed. You must configure permissions for the person or service calling this endpoint and add this permission to their identity.

Authorizations

clientCredentials

OAuth2authorizationCodeRequired

An OIDC service account that was authenticated.

Token URL:

Path parameters

userIdstringRequired

appIdstringRequired

Responses

200

OK

No content

401

Unauthorized

*/*

delete

/consent/admin/{userId}/apps/{appId}

HTTPcURLJavaScriptPython

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

No content

Remove specific consent for a client application.

delete

Revokes a specific consent scope associated with a client application for a user. This operation is intended for administrative users to manage consent settings effectively. It ensures that user privacy preferences are respected and maintained.

💻 Service Credentials is required to access this service.

🔒 Permission: user.consent.delete is required in order for the call to succeed. You must configure permissions for the person or service calling this endpoint and add this permission to their identity.

Authorizations

clientCredentials

OAuth2authorizationCodeRequired

An OIDC service account that was authenticated.

Token URL:

Path parameters

userIdstringRequired

appIdstringRequired

scopestringRequired

Responses

200

OK

No content

401

Unauthorized

*/*

delete

/consent/admin/{userId}/apps/{appId}/scopes/{scope}

HTTPcURLJavaScriptPython

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

No content

Admin remove consent for a specific experiment.

delete

This endpoint allows administrators to revoke consent for a user in relation to a specific experiment. It ensures that the user's preferences are respected and that their data is managed appropriately. Use this operation to maintain compliance with consent requirements.

💻 Service Credentials is required to access this service.

🔒 Permission: user.consent.delete is required in order for the call to succeed. You must configure permissions for the person or service calling this endpoint and add this permission to their identity.

Authorizations

clientCredentials

OAuth2authorizationCodeRequired

An OIDC service account that was authenticated.

Token URL:

Path parameters

userIdstringRequired

experiment_idstringRequired

Responses

200

OK

No content

401

Unauthorized

*/*

delete

/consent/admin/{userId}/experiments/{experiment_id}

HTTPcURLJavaScriptPython

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

No content