Consent Scope APIs

Provides access to consent and privacy operations.

List configured consent attributes for the organization

get

Retrieve all currently available consent attributes configured for the specified organization. This endpoint provides essential information for consent administration and governance, 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.

Authorizations

authorizationCode

OAuth2clientCredentialsRequired

An OIDC service account that was authenticated.

Authorization URL: Token URL:

Path parameters

organizationIdstringRequired

Responses

200

The available consent scopes to use in applications.

application/json

401

Unauthorized

*/*

get

/consent/scopes/{organizationId}

HTTPcURLJavaScriptPython

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

[
  {
    "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
  }
]

Create a new consent attribute for the organization

post

This endpoint allows the authorized principal to create and register a new consent attribute within the specified organization. It ensures that the consent attribute is properly managed for compliance with privacy regulations and organizational policies.

👤 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

Body

application/json

idstringOptional

categorystringOptional

subcategorystringOptional

org_idstringOptional

statusstring · enumOptionalPossible values:

sensitivitystring · enumOptionalPossible values:

visiblebooleanOptional

Responses

200

OK

*/*

401

Unauthorized

*/*

post

/consent/scopes/{organizationId}

HTTPcURLJavaScriptPython

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

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

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

Update consent scope for the organization

put

This endpoint allows you to update the consent scope associated with a specific organization. It ensures that the consent attributes are aligned with the organization's policies and governance. Use this operation to maintain compliance and manage user consent 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.

🔒 Permission: org.consent.scopes.update 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

authorizationCode

OAuth2clientCredentialsRequired

An OIDC service account that was authenticated.

Authorization URL: Token URL:

Path parameters

organizationIdstringRequired

scopeIdstringRequired

Body

application/json

idstringOptional

categorystringOptional

subcategorystringOptional

org_idstringOptional

statusstring · enumOptionalPossible values:

sensitivitystring · enumOptionalPossible values:

visiblebooleanOptional

Responses

200

OK

*/*

401

Unauthorized

*/*

put

/consent/scopes/{organizationId}/{scopeId}

HTTPcURLJavaScriptPython

PUT /consent/scopes/{organizationId}/{scopeId} HTTP/1.1
Host: gateway.dev.klustr.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 194

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

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