Consent Household APIs

Provides access to consent and privacy operations.

Retrieve consent details for a specific user.

get

This endpoint allows administrators to retrieve all consent information for a specified user within a household. It ensures that only authorized personnel can access sensitive consent data, maintaining privacy and compliance standards.

👤 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

householdIdstringRequired

personIdstringRequired

Responses

200

OK

*/*

401

Unauthorized

*/*

get

/consent/household/{householdId}/members/{personId}

HTTPcURLJavaScriptPython

GET /consent/household/{householdId}/members/{personId} 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": "2026-02-12T20:04:00.637Z",
          "date_revoked": "2026-02-12T20:04:00.637Z",
          "date_modified": "2026-02-12T20:04:00.637Z"
        }
      ],
      "apps": [
        {
          "app_id": "text",
          "app_name": "text",
          "app_logo": "https://example.com",
          "scopes": [
            {
              "id": "text",
              "status": "active",
              "consent_method": "implicit",
              "date_created": "2026-02-12T20:04:00.637Z",
              "date_revoked": "2026-02-12T20:04:00.637Z",
              "date_modified": "2026-02-12T20:04:00.637Z"
            }
          ],
          "experiments": [
            {
              "experiment_id": "text",
              "experiment_name": "text",
              "scopes": [
                {
                  "id": "text",
                  "status": "active",
                  "consent_method": "implicit",
                  "date_created": "2026-02-12T20:04:00.637Z",
                  "date_revoked": "2026-02-12T20:04:00.637Z",
                  "date_modified": "2026-02-12T20:04:00.637Z"
                }
              ]
            }
          ]
        }
      ],
      "agreements": [
        {
          "agreement_id": "text",
          "agreement_name": "text",
          "scopes": [
            {
              "id": "text",
              "status": "active",
              "consent_method": "implicit",
              "date_created": "2026-02-12T20:04:00.637Z",
              "date_revoked": "2026-02-12T20:04:00.637Z",
              "date_modified": "2026-02-12T20:04:00.637Z"
            }
          ]
        }
      ]
    }
  ]
}

Retrieve agreements for a user in a household.

get

This endpoint returns all user agreements associated with the specified household and person. It is intended for authorized users to access their agreements, ensuring transparency and compliance with privacy regulations. Use this to understand the commitments made within the household context.

👤 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

householdIdstringRequired

personIdstringRequired

Responses

200

OK

*/*

401

Unauthorized

*/*

get

/consent/household/{householdId}/members/{personId}/agreements

HTTPcURLJavaScriptPython

GET /consent/household/{householdId}/members/{personId}/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": "2026-02-12T20:04:00.637Z",
      "last_seen_date": "2026-02-12T20:04:00.637Z",
      "status": "active",
      "id": "text",
      "subject_id": "text",
      "scopes": [
        {
          "id": "text",
          "status": "active",
          "consent_method": "implicit",
          "date_created": "2026-02-12T20:04:00.637Z",
          "date_revoked": "2026-02-12T20:04:00.637Z",
          "date_modified": "2026-02-12T20:04:00.637Z"
        }
      ]
    }
  ],
  "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": "2026-02-12T20:04:00.637Z",
          "effective_date": "2026-02-12T20:04:00.637Z",
          "scopes": [
            {
              "id": "text",
              "sensitivity": "text",
              "purpose": [
                "COLLECTION"
              ]
            }
          ],
          "content": [
            {
              "url": "text",
              "title": "text",
              "locale": "text",
              "mime_type": "text",
              "date_created": "2026-02-12T20:04:00.637Z",
              "date_modified": "2026-02-12T20:04:00.637Z"
            }
          ],
          "status": "draft"
        }
      ],
      "status": "test",
      "type": "privacy_policy",
      "date_created": "2026-02-12T20:04:00.637Z",
      "date_modified": "2026-02-12T20:04:00.637Z",
      "owner": {
        "email": "text"
      }
    }
  }
}

Delete a user's agreement in the household.

delete

This endpoint allows for the deletion of a specific user agreement within a household. It is intended for use by authorized users to manage consent agreements effectively. Ensure that the correct household and user identifiers are provided to avoid unintended deletions.

👤 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

householdIdstringRequired

personIdstringRequired

agreementIdstringRequired

Responses

200

OK

No content

401

Unauthorized

*/*

delete

/consent/household/{householdId}/members/{personId}/agreements/{agreementId}

HTTPcURLJavaScriptPython

DELETE /consent/household/{householdId}/members/{personId}/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 details associated with the specified application ID for a given household and person. This endpoint is essential for understanding user permissions and privacy settings. It ensures that applications comply with user 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

householdIdstringRequired

personIdstringRequired

appIdstringRequired

Responses

200

OK

*/*

401

Unauthorized

*/*

get

/consent/household/{householdId}/members/{personId}/apps/{appId}

HTTPcURLJavaScriptPython

GET /consent/household/{householdId}/members/{personId}/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": "2026-02-12T20:04:00.637Z",
    "last_seen_date": "2026-02-12T20:04:00.637Z",
    "first_seen_date": "2026-02-12T20:04:00.637Z",
    "impressions": 1,
    "scopes": [
      {
        "id": "text",
        "status": "active",
        "consent_method": "implicit",
        "date_created": "2026-02-12T20:04:00.637Z",
        "date_revoked": "2026-02-12T20:04:00.637Z",
        "date_modified": "2026-02-12T20:04:00.637Z"
      }
    ],
    "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": "2026-02-12T20:04:00.637Z",
        "stop_date": "2026-02-12T20:04:00.637Z"
      },
      "consent": {
        "experiment_id": "text",
        "client_id": "text",
        "app_id": "text",
        "project_id": "text",
        "org_id": "text",
        "first_seen_date": "2026-02-12T20:04:00.637Z",
        "last_seen_date": "2026-02-12T20:04:00.637Z",
        "status": "active",
        "id": "text",
        "subject_id": "text",
        "scopes": [
          {
            "id": "text",
            "status": "active",
            "consent_method": "implicit",
            "date_created": "2026-02-12T20:04:00.637Z",
            "date_revoked": "2026-02-12T20:04:00.637Z",
            "date_modified": "2026-02-12T20:04:00.637Z"
          }
        ]
      }
    }
  ],
  "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": "2026-02-12T20:04:00.637Z",
  "last_seen_date": "2026-02-12T20:04:00.637Z"
}

Revoke consent for a specific application user.

delete

This endpoint allows users to revoke consent for a specific application associated with their household. It ensures that all permissions granted to the application are removed, enhancing user privacy and control over their data. This operation is crucial for maintaining compliance with consent 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.

Authorizations

authorizationCode

OAuth2clientCredentialsRequired

An OIDC service account that was authenticated.

Authorization URL: Token URL:

Path parameters

householdIdstringRequired

personIdstringRequired

appIdstringRequired

Responses

200

OK

No content

401

Unauthorized

*/*

delete

/consent/household/{householdId}/members/{personId}/apps/{appId}

HTTPcURLJavaScriptPython

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

No content

Revoke consent for a specific application scope

delete

This endpoint allows the removal of consent for a specific scope associated with a user's application. It is intended for household-level consent management, ensuring that users can control their privacy settings effectively. Use this operation to maintain compliance and user trust.

👤 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

householdIdstringRequired

personIdstringRequired

appIdstringRequired

scopestringRequired

Responses

200

OK

*/*

401

Unauthorized

*/*

delete

/consent/household/{householdId}/members/{personId}/apps/{appId}/scopes/{scope}

HTTPcURLJavaScriptPython

DELETE /consent/household/{householdId}/members/{personId}/apps/{appId}/scopes/{scope} 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": "2026-02-12T20:04:00.637Z",
    "last_seen_date": "2026-02-12T20:04:00.637Z",
    "first_seen_date": "2026-02-12T20:04:00.637Z",
    "impressions": 1,
    "scopes": [
      {
        "id": "text",
        "status": "active",
        "consent_method": "implicit",
        "date_created": "2026-02-12T20:04:00.637Z",
        "date_revoked": "2026-02-12T20:04:00.637Z",
        "date_modified": "2026-02-12T20:04:00.637Z"
      }
    ],
    "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": "2026-02-12T20:04:00.637Z",
        "stop_date": "2026-02-12T20:04:00.637Z"
      },
      "consent": {
        "experiment_id": "text",
        "client_id": "text",
        "app_id": "text",
        "project_id": "text",
        "org_id": "text",
        "first_seen_date": "2026-02-12T20:04:00.637Z",
        "last_seen_date": "2026-02-12T20:04:00.637Z",
        "status": "active",
        "id": "text",
        "subject_id": "text",
        "scopes": [
          {
            "id": "text",
            "status": "active",
            "consent_method": "implicit",
            "date_created": "2026-02-12T20:04:00.637Z",
            "date_revoked": "2026-02-12T20:04:00.637Z",
            "date_modified": "2026-02-12T20:04:00.637Z"
          }
        ]
      }
    }
  ],
  "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": "2026-02-12T20:04:00.637Z",
  "last_seen_date": "2026-02-12T20:04:00.637Z"
}

Revoke consent for a specific household experiment

delete

This endpoint allows users to revoke consent for a specific experiment associated with a household. It ensures that the individual's preferences regarding participation in experiments are respected and updated accordingly. This operation is crucial for maintaining privacy and compliance with consent 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.

Authorizations

authorizationCode

OAuth2clientCredentialsRequired

An OIDC service account that was authenticated.

Authorization URL: Token URL:

Path parameters

householdIdstringRequired

personIdstringRequired

experiment_idstringRequired

Responses

200

OK

No content

401

Unauthorized

*/*

delete

/consent/household/{householdId}/members/{personId}/experiments/{experiment_id}

HTTPcURLJavaScriptPython

DELETE /consent/household/{householdId}/members/{personId}/experiments/{experiment_id} HTTP/1.1
Host: gateway.dev.klustr.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

No content