Your suggested change has been received. Thank you.

close
Thales Logo

All

  • All
  • CipherTrust Manager
  • CipherTrust Application Data Protection (CADP)
  • CipherTrust Application Key Management (CAKM)
  • CipherTrust Batch Data Transformation (BDT)
  • CipherTrust Cloud Key Management (CCKM)
  • CipherTrust Data Discovery and Classification (DDC)
  • CipherTrust Data Protection Gateway (DPG)
  • CipherTrust Database Protection (CDP)
  • CipherTrust Intelligent Protection (CIP)
  • CipherTrust Integrations
  • CipherTrust Migrations
  • CipherTrust RESTful Data Protection (CRDP)
  • CipherTrust Transparent Encryption (CTE)
  • CipherTrust Transparent Encryption Userspace (CTE-U)
  • CipherTrust Secrets Management (CSM)
  • CipherTrust Vaulted Tokenization (CT-V)
  • CipherTrust Vaultless Tokenization (CT-VL)
  • CTE-Linux
  • CTE-Windows
  • CTE-AIX
  • CTE-K8s
  • CTE-U
  • Crypto Command Center
  • Data Protection on Demand
  • Luna Cloud HSM
  • Luna Network HSM
  • Luna PCIe HSM
  • Luna USB HSM
  • OneWelcome Identity Platform
  • ProtectApp LUKS
  • ProtectServer 2 HSM
  • ProtectServer 3 HSM
  • SafeNet Trusted Access (STA)
  • SafeNet MobilePASS+
  • SafeNet MobilePASS+ for Android
  • SafeNet MobilePASS+ for Chrome
  • SafeNet MobilePASS+ for macOS
  • SafeNet MobilePASS+ for iOS
  • SafeNet MobilePASS+ for WatchOS
  • SafeNet MobilePASS+ for Windows
  • SafeNet Synchronization Agent
  • SafeNet Logging Agent
  • SafeNet Agent for FreeRADIUS
  • SafeNet Agent for NPS
  • SafeNet Agent for Windows Logon
  • SafeNet Authentication Service Private Cloud Edition (SAS PCE)
  • SafeNet Remote Logging Agent
  • SafeNet Keycloak Agent
  • SafeNet IDPrime Virtual (IDPV)
  • SafeNet FIDO Key Manager
  • SafeNet FIDO Key Manager for Android
  • SafeNet FIDO Key Manager for iOS
  • SafeNet FIDO Key Manager for Windows
redocly logoAPI docs by Redocly

Consent Config API (0.0.1)

Download OpenAPI specification:Download

Consent Config API documentation

Consent Config API

Create Attribute Consent Definition

Creates the Attribute Consent Definition specified by {definitionName}.

Authorizations:
bearer
path Parameters
definitionName
required
string

The identifier for the ConsentDefinition.

tenant
required
string

Your tenant code.

query Parameters
refresh_user_details
boolean

Indicates whether the userinfo cache associated with the OneWelcome token is refreshed. By default, false.

header Parameters
acting-tenant-id
string

Tenant code. Used when not passing the tenant code in the URL path parameter

tenant-id
string

Tenant code. Used when not passing the tenant code in the URL path parameter or no acting tenant

Responses

Response samples

Content type
application/json
{ }

Get Attribute Consent Definition

Returns the Attribute Consent Definition specified by {definitionName}.

Authorizations:
bearer
path Parameters
definitionName
required
string

The identifier for the ConsentDefinition.

tenant
required
string

Your tenant code.

query Parameters
refresh_user_details
boolean

Indicates whether the userinfo cache associated with the OneWelcome token is refreshed. By default, false.

header Parameters
acting-tenant-id
string

Tenant code. Used when not passing the tenant code in the URL path parameter

tenant-id
string

Tenant code. Used when not passing the tenant code in the URL path parameter or no acting tenant

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "displayName": "string",
  • "type": "document",
  • "versionsCount": 0
}

Delete Attribute Consent Definition

Deletes the Attribute Consent Definition specified by {definitionName}.

Authorizations:
bearer
path Parameters
definitionName
required
string

The identifier for the ConsentDefinition.

tenant
required
string

Your tenant code.

query Parameters
refresh_user_details
boolean

Indicates whether the userinfo cache associated with the OneWelcome token is refreshed. By default, false.

header Parameters
acting-tenant-id
string

Tenant code. Used when not passing the tenant code in the URL path parameter

tenant-id
string

Tenant code. Used when not passing the tenant code in the URL path parameter or no acting tenant

Responses

Response samples

Content type
application/json
{ }

Create Attribute Consent Definition

Creates the Attribute Consent Definition specified by {definitionName}.

Authorizations:
bearer
path Parameters
definitionName
required
string

The identifier for the ConsentDefinition.

tenant
required
string

Your tenant code.

query Parameters
refresh_user_details
boolean

Indicates whether the userinfo cache associated with the OneWelcome token is refreshed. By default, false.

header Parameters
acting-tenant-id
string

Tenant code. Used when not passing the tenant code in the URL path parameter

tenant-id
string

Tenant code. Used when not passing the tenant code in the URL path parameter or no acting tenant

Responses

Response samples

Content type
application/json
{ }

Get Attribute Consent Definition

Returns the Attribute Consent Definition specified by {definitionName}.

Authorizations:
bearer
path Parameters
definitionName
required
string

The identifier for the ConsentDefinition.

tenant
required
string

Your tenant code.

query Parameters
refresh_user_details
boolean

Indicates whether the userinfo cache associated with the OneWelcome token is refreshed. By default, false.

header Parameters
acting-tenant-id
string

Tenant code. Used when not passing the tenant code in the URL path parameter

tenant-id
string

Tenant code. Used when not passing the tenant code in the URL path parameter or no acting tenant

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "displayName": "string",
  • "type": "document",
  • "versionsCount": 0
}

Delete Attribute Consent Definition

Deletes the Attribute Consent Definition specified by {definitionName}.

Authorizations:
bearer
path Parameters
definitionName
required
string

The identifier for the ConsentDefinition.

tenant
required
string

Your tenant code.

query Parameters
refresh_user_details
boolean

Indicates whether the userinfo cache associated with the OneWelcome token is refreshed. By default, false.

header Parameters
acting-tenant-id
string

Tenant code. Used when not passing the tenant code in the URL path parameter

tenant-id
string

Tenant code. Used when not passing the tenant code in the URL path parameter or no acting tenant

Responses

Response samples

Content type
application/json
{ }

List all Attribute Consent Definitions

Lists all defined Attribute Consent Definitions.

Authorizations:
bearer
path Parameters
tenant
required
string

Your tenant code.

query Parameters
details
required
any

Indicates whether the complete config of the requested objects is included in the response.

refresh_user_details
boolean

Indicates whether the userinfo cache associated with the OneWelcome token is refreshed. By default, false.

header Parameters
acting-tenant-id
string

Tenant code. Used when not passing the tenant code in the URL path parameter

tenant-id
string

Tenant code. Used when not passing the tenant code in the URL path parameter or no acting tenant

Responses

Response samples

Content type
application/json
{
  • "resources": [
    ],
  • "config": [
    ]
}

List all Attribute Consent Definitions

Lists all defined Attribute Consent Definitions.

Authorizations:
bearer
path Parameters
tenant
required
string

Your tenant code.

query Parameters
details
required
any

Indicates whether the complete config of the requested objects is included in the response.

refresh_user_details
boolean

Indicates whether the userinfo cache associated with the OneWelcome token is refreshed. By default, false.

header Parameters
acting-tenant-id
string

Tenant code. Used when not passing the tenant code in the URL path parameter

tenant-id
string

Tenant code. Used when not passing the tenant code in the URL path parameter or no acting tenant

Responses

Response samples

Content type
application/json
{
  • "resources": [
    ],
  • "config": [
    ]
}

List all ConsentVersions

Lists all ConsentVersions of ConsentDefinition {definitionName}.

Authorizations:
bearer
path Parameters
definitionName
required
string

The identifier for the ConsentDefinition.

tenant
required
string

Your tenant code.

query Parameters
details
required
any

Indicates whether the complete config of the requested objects is included in the response.

refresh_user_details
boolean

Indicates whether the userinfo cache associated with the OneWelcome token is refreshed. By default, false.

header Parameters
acting-tenant-id
string

Tenant code. Used when not passing the tenant code in the URL path parameter

tenant-id
string

Tenant code. Used when not passing the tenant code in the URL path parameter or no acting tenant

Responses

Response samples

Content type
application/json
{
  • "resources": [
    ],
  • "config": [
    ]
}

List all ConsentVersions

Lists all ConsentVersions of ConsentDefinition {definitionName}.

Authorizations:
bearer
path Parameters
definitionName
required
string

The identifier for the ConsentDefinition.

tenant
required
string

Your tenant code.

query Parameters
details
required
any

Indicates whether the complete config of the requested objects is included in the response.

refresh_user_details
boolean

Indicates whether the userinfo cache associated with the OneWelcome token is refreshed. By default, false.

header Parameters
acting-tenant-id
string

Tenant code. Used when not passing the tenant code in the URL path parameter

tenant-id
string

Tenant code. Used when not passing the tenant code in the URL path parameter or no acting tenant

Responses

Response samples

Content type
application/json
{
  • "resources": [
    ],
  • "config": [
    ]
}

Get ConsentVersion

Returns ConsentVersion {version} of ConsentDefinition {definitionName}.

Authorizations:
bearer
path Parameters
definitionName
required
string

The identifier for the ConsentDefinition.

version
required
string

The identifier for the ConsentVersion.

tenant
required
string

Your tenant code.

query Parameters
refresh_user_details
boolean

Indicates whether the userinfo cache associated with the OneWelcome token is refreshed. By default, false.

header Parameters
acting-tenant-id
string

Tenant code. Used when not passing the tenant code in the URL path parameter

tenant-id
string

Tenant code. Used when not passing the tenant code in the URL path parameter or no acting tenant

Responses

Response samples

Content type
application/json
{
  • "resources": [
    ],
  • "config": {
    }
}

Create ConsentVersion

Creates the ConsentVersion {version} of ConsentDefinition {definitionName}.

Authorizations:
bearer
path Parameters
definitionName
required
string

The identifier for the ConsentDefinition.

version
required
string

The identifier for the ConsentVersion.

tenant
required
string

Your tenant code.

query Parameters
refresh_user_details
boolean

Indicates whether the userinfo cache associated with the OneWelcome token is refreshed. By default, false.

header Parameters
acting-tenant-id
string

Tenant code. Used when not passing the tenant code in the URL path parameter

tenant-id
string

Tenant code. Used when not passing the tenant code in the URL path parameter or no acting tenant

Request Body schema: application/json
required
Array of objects (OptInConfigRequest)
description
string
displayName
string

Responses

Request samples

Content type
application/json
{
  • "optInConfig": [
    ],
  • "description": "string",
  • "displayName": "string"
}

Response samples

Content type
application/json
{ }

Delete ConsentVersion

Deletes the ConsentVersion {version} of ConsentDefinition {definitionName}.

Authorizations:
bearer
path Parameters
definitionName
required
string

The identifier for the ConsentDefinition.

version
required
string

The identifier for the ConsentVersion.

tenant
required
string

Your tenant code.

query Parameters
refresh_user_details
boolean

Indicates whether the userinfo cache associated with the OneWelcome token is refreshed. By default, false.

header Parameters
acting-tenant-id
string

Tenant code. Used when not passing the tenant code in the URL path parameter

tenant-id
string

Tenant code. Used when not passing the tenant code in the URL path parameter or no acting tenant

Responses

Response samples

Content type
application/json
{ }

Update ConsentVersion

Creates or updates ConsentVersion {version} of ConsentDefinition {definitionName}.

Note: A PUT request overwrites the original object. Be sure to (re-)enter the values for all desired properties.

Authorizations:
bearer
path Parameters
definitionName
required
string

The identifier for the ConsentDefinition.

version
required
string

The identifier for the ConsentVersion.

tenant
required
string

Your tenant code.

query Parameters
refresh_user_details
boolean

Indicates whether the userinfo cache associated with the OneWelcome token is refreshed. By default, false.

header Parameters
acting-tenant-id
string

Tenant code. Used when not passing the tenant code in the URL path parameter

tenant-id
string

Tenant code. Used when not passing the tenant code in the URL path parameter or no acting tenant

Request Body schema: application/json
required
Array of objects (OptInConfigRequest)
description
string
displayName
string

Responses

Request samples

Content type
application/json
{
  • "optInConfig": [
    ],
  • "description": "string",
  • "displayName": "string"
}

Response samples

Content type
application/json
{ }

Get ConsentVersion

Returns ConsentVersion {version} of ConsentDefinition {definitionName}.

Authorizations:
bearer
path Parameters
definitionName
required
string

The identifier for the ConsentDefinition.

version
required
string

The identifier for the ConsentVersion.

tenant
required
string

Your tenant code.

query Parameters
refresh_user_details
boolean

Indicates whether the userinfo cache associated with the OneWelcome token is refreshed. By default, false.

header Parameters
acting-tenant-id
string

Tenant code. Used when not passing the tenant code in the URL path parameter

tenant-id
string

Tenant code. Used when not passing the tenant code in the URL path parameter or no acting tenant

Responses

Response samples

Content type
application/json
{
  • "resources": [
    ],
  • "config": {
    }
}

Create ConsentVersion

Creates the ConsentVersion {version} of ConsentDefinition {definitionName}.

Authorizations:
bearer
path Parameters
definitionName
required
string

The identifier for the ConsentDefinition.

version
required
string

The identifier for the ConsentVersion.

tenant
required
string

Your tenant code.

query Parameters
refresh_user_details
boolean

Indicates whether the userinfo cache associated with the OneWelcome token is refreshed. By default, false.

header Parameters
acting-tenant-id
string

Tenant code. Used when not passing the tenant code in the URL path parameter

tenant-id
string

Tenant code. Used when not passing the tenant code in the URL path parameter or no acting tenant

Request Body schema: application/json
required
Array of objects (OptInConfigRequest)
description
string
displayName
string

Responses

Request samples

Content type
application/json
{
  • "optInConfig": [
    ],
  • "description": "string",
  • "displayName": "string"
}

Response samples

Content type
application/json
{ }

Delete ConsentVersion

Deletes the ConsentVersion {version} of ConsentDefinition {definitionName}.

Authorizations:
bearer
path Parameters
definitionName
required
string

The identifier for the ConsentDefinition.

version
required
string

The identifier for the ConsentVersion.

tenant
required
string

Your tenant code.

query Parameters
refresh_user_details
boolean

Indicates whether the userinfo cache associated with the OneWelcome token is refreshed. By default, false.

header Parameters
acting-tenant-id
string

Tenant code. Used when not passing the tenant code in the URL path parameter

tenant-id
string

Tenant code. Used when not passing the tenant code in the URL path parameter or no acting tenant

Responses

Response samples

Content type
application/json
{ }

Update ConsentVersion

Creates or updates ConsentVersion {version} of ConsentDefinition {definitionName}.

Note: A PUT request overwrites the original object. Be sure to (re-)enter the values for all desired properties.

Authorizations:
bearer
path Parameters
definitionName
required
string

The identifier for the ConsentDefinition.

version
required
string

The identifier for the ConsentVersion.

tenant
required
string

Your tenant code.

query Parameters
refresh_user_details
boolean

Indicates whether the userinfo cache associated with the OneWelcome token is refreshed. By default, false.

header Parameters
acting-tenant-id
string

Tenant code. Used when not passing the tenant code in the URL path parameter

tenant-id
string

Tenant code. Used when not passing the tenant code in the URL path parameter or no acting tenant

Request Body schema: application/json
required
Array of objects (OptInConfigRequest)
description
string
displayName
string

Responses

Request samples

Content type
application/json
{
  • "optInConfig": [
    ],
  • "description": "string",
  • "displayName": "string"
}

Response samples

Content type
application/json
{ }

Get endOfLife of ConsentVersion

Returns the endOfLife associated with the ConsentVersion {version} of ConsentDefinition {definitionName}.

Authorizations:
bearer
path Parameters
definitionName
required
string

The identifier for the ConsentDefinition.

version
required
string

The identifier for the ConsentVersion.

tenant
required
string

Your tenant code.

query Parameters
refresh_user_details
boolean

Indicates whether the userinfo cache associated with the OneWelcome token is refreshed. By default, false.

header Parameters
acting-tenant-id
string

Tenant code. Used when not passing the tenant code in the URL path parameter

tenant-id
string

Tenant code. Used when not passing the tenant code in the URL path parameter or no acting tenant

Responses

Response samples

Content type
application/json
{
  • "config": {
    }
}

Create/update EndOfLife of ConsentVersion

Creates or updates the endOfLife associated with the ConsentVersion {version} of ConsentDefinition {definitionName}.

Note: A PUT request overwrites the original object. Be sure to (re-)enter the values for all desired properties.

Authorizations:
bearer
path Parameters
definitionName
required
string

The identifier for the ConsentDefinition.

version
required
string

The identifier for the ConsentVersion.

tenant
required
string

Your tenant code.

query Parameters
refresh_user_details
boolean

Indicates whether the userinfo cache associated with the OneWelcome token is refreshed. By default, false.

header Parameters
acting-tenant-id
string

Tenant code. Used when not passing the tenant code in the URL path parameter

tenant-id
string

Tenant code. Used when not passing the tenant code in the URL path parameter or no acting tenant

Request Body schema: application/json
startDate
required
string

A datetime (ISO-8601 format) indicating the first moment in time that users can receive notifications to report the termination of the associated ConsentVersion. This notification should include an invitation to accept the new version of the consent. startDate can only be set to a future moment in time and must lie before endDate.

endDate
required
string

A datetime (ISO-8601 format) indicating the last moment in time that a ConsentDocument of the associated ConsentVersion can be valid.

gracePeriod
required
string

A duration (ISO-8601 period format) indicating the period the user gets to agree to the new active ConsentDocument. This period starts the moment the user receives the first invitation to accept this new ConsentDocument. The actual grace period for a specific user is never extended beyond the endDate.

Responses

Request samples

Content type
application/json
{
  • "startDate": "string",
  • "endDate": "string",
  • "gracePeriod": "string"
}

Response samples

Content type
application/json
{ }

Delete EndOfLife of ConsentVersion

Deletes the endOfLife associated with the ConsentVersion {version} of ConsentDefinition {definitionName}.

Authorizations:
bearer
path Parameters
definitionName
required
string

The identifier for the ConsentDefinition.

version
required
string

The identifier for the ConsentVersion.

tenant
required
string

Your tenant code.

query Parameters
refresh_user_details
boolean

Indicates whether the userinfo cache associated with the OneWelcome token is refreshed. By default, false.

header Parameters
acting-tenant-id
string

Tenant code. Used when not passing the tenant code in the URL path parameter

tenant-id
string

Tenant code. Used when not passing the tenant code in the URL path parameter or no acting tenant

Responses

Response samples

Content type
application/json
{ }

Get endOfLife of ConsentVersion

Returns the endOfLife associated with the ConsentVersion {version} of ConsentDefinition {definitionName}.

Authorizations:
bearer
path Parameters
definitionName
required
string

The identifier for the ConsentDefinition.

version
required
string

The identifier for the ConsentVersion.

tenant
required
string

Your tenant code.

query Parameters
refresh_user_details
boolean

Indicates whether the userinfo cache associated with the OneWelcome token is refreshed. By default, false.

header Parameters
acting-tenant-id
string

Tenant code. Used when not passing the tenant code in the URL path parameter

tenant-id
string

Tenant code. Used when not passing the tenant code in the URL path parameter or no acting tenant

Responses

Response samples

Content type
application/json
{
  • "config": {
    }
}

Create/update EndOfLife of ConsentVersion

Creates or updates the endOfLife associated with the ConsentVersion {version} of ConsentDefinition {definitionName}.

Note: A PUT request overwrites the original object. Be sure to (re-)enter the values for all desired properties.

Authorizations:
bearer
path Parameters
definitionName
required
string

The identifier for the ConsentDefinition.

version
required
string

The identifier for the ConsentVersion.

tenant
required
string

Your tenant code.

query Parameters
refresh_user_details
boolean

Indicates whether the userinfo cache associated with the OneWelcome token is refreshed. By default, false.

header Parameters
acting-tenant-id
string

Tenant code. Used when not passing the tenant code in the URL path parameter

tenant-id
string

Tenant code. Used when not passing the tenant code in the URL path parameter or no acting tenant

Request Body schema: application/json
startDate
required
string

A datetime (ISO-8601 format) indicating the first moment in time that users can receive notifications to report the termination of the associated ConsentVersion. This notification should include an invitation to accept the new version of the consent. startDate can only be set to a future moment in time and must lie before endDate.

endDate
required
string

A datetime (ISO-8601 format) indicating the last moment in time that a ConsentDocument of the associated ConsentVersion can be valid.

gracePeriod
required
string

A duration (ISO-8601 period format) indicating the period the user gets to agree to the new active ConsentDocument. This period starts the moment the user receives the first invitation to accept this new ConsentDocument. The actual grace period for a specific user is never extended beyond the endDate.

Responses

Request samples

Content type
application/json
{
  • "startDate": "string",
  • "endDate": "string",
  • "gracePeriod": "string"
}

Response samples

Content type
application/json
{ }

Delete EndOfLife of ConsentVersion

Deletes the endOfLife associated with the ConsentVersion {version} of ConsentDefinition {definitionName}.

Authorizations:
bearer
path Parameters
definitionName
required
string

The identifier for the ConsentDefinition.

version
required
string

The identifier for the ConsentVersion.

tenant
required
string

Your tenant code.

query Parameters
refresh_user_details
boolean

Indicates whether the userinfo cache associated with the OneWelcome token is refreshed. By default, false.

header Parameters
acting-tenant-id
string

Tenant code. Used when not passing the tenant code in the URL path parameter

tenant-id
string

Tenant code. Used when not passing the tenant code in the URL path parameter or no acting tenant

Responses

Response samples

Content type
application/json
{ }

List all AttributeConsentDocuments

Lists all AttributeConsentDocument

Authorizations:
bearer
path Parameters
definitionName
required
string

The identifier for the ConsentDefinition.

version
required
string

The identifier for the ConsentVersion.

tenant
required
string

Your tenant code.

query Parameters
language
required
string

Document language

status
required
string
Enum: "draft" "active"

Status of the attribute documents

attributes
required
any

Comma-separated attributes to filter by. Only documents that match all given attributes will be returned

legalBasis
required
string
Enum: "Consent" "Contract" "Legal obligation" "Legitimate interest" "Public task" "Vital interest"

Legal Basis

title
required
any

Partial match for the title (displayName). Case insensitive

details
required
any

Indicates whether the complete config of the requested objects is included in the response.

refresh_user_details
boolean

Indicates whether the userinfo cache associated with the OneWelcome token is refreshed. By default, false.

header Parameters
acting-tenant-id
string

Tenant code. Used when not passing the tenant code in the URL path parameter

tenant-id
string

Tenant code. Used when not passing the tenant code in the URL path parameter or no acting tenant

Responses

Response samples

Content type
application/json
{
  • "resources": [
    ],
  • "config": [
    ]
}

List all AttributeConsentDocuments

Lists all AttributeConsentDocument

Authorizations:
bearer
path Parameters
definitionName
required
string

The identifier for the ConsentDefinition.

version
required
string

The identifier for the ConsentVersion.

tenant
required
string

Your tenant code.

query Parameters
language
required
string

Document language

status
required
string
Enum: "draft" "active"

Status of the attribute documents

attributes
required
any

Comma-separated attributes to filter by. Only documents that match all given attributes will be returned

legalBasis
required
string
Enum: "Consent" "Contract" "Legal obligation" "Legitimate interest" "Public task" "Vital interest"

Legal Basis

title
required
any

Partial match for the title (displayName). Case insensitive

details
required
any

Indicates whether the complete config of the requested objects is included in the response.

refresh_user_details
boolean

Indicates whether the userinfo cache associated with the OneWelcome token is refreshed. By default, false.

header Parameters
acting-tenant-id
string

Tenant code. Used when not passing the tenant code in the URL path parameter

tenant-id
string

Tenant code. Used when not passing the tenant code in the URL path parameter or no acting tenant

Responses

Response samples

Content type
application/json
{
  • "resources": [
    ],
  • "config": [
    ]
}

Get AttributeConsentDocument

Returns the AttributeConsentDocument specified by {documentId} in AttributeConsentVersion {version} of AttributeConsentDefinition {definitionName}.

Authorizations:
bearer
path Parameters
definitionName
required
string

The identifier for the ConsentDefinition.

version
required
string

The identifier for the ConsentVersion.

documentId
required
string

The unique id that identifies an AttributeConsentDocument. It follows the format '{documentVersion}|{documentLanguage}'

tenant
required
string

Your tenant code.

query Parameters
refresh_user_details
boolean

Indicates whether the userinfo cache associated with the OneWelcome token is refreshed. By default, false.

header Parameters
acting-tenant-id
string

Tenant code. Used when not passing the tenant code in the URL path parameter

tenant-id
string

Tenant code. Used when not passing the tenant code in the URL path parameter or no acting tenant

Responses

Response samples

Content type
application/json
{
  • "config": {
    }
}

Update AttributeConsentDocument

Updates the AttributeConsentDocument specified by {documentId} in the AttributeConsentVersion {version} of AttributeConsentDefinition {definitionName}.

Note: A PUT request overwrites the original object. Be sure to (re-)enter the values for all desired properties.

Authorizations:
bearer
path Parameters
definitionName
required
string

The identifier for the ConsentDefinition.

version
required
string

The identifier for the ConsentVersion.

documentId
required
string

The unique id that identifies an AttributeConsentDocument. It follows the format '{documentVersion}|{documentLanguage}'

tenant
required
string

Your tenant code.

query Parameters
refresh_user_details
boolean

Indicates whether the userinfo cache associated with the OneWelcome token is refreshed. By default, false.

header Parameters
acting-tenant-id
string

Tenant code. Used when not passing the tenant code in the URL path parameter

tenant-id
string

Tenant code. Used when not passing the tenant code in the URL path parameter or no acting tenant

Request Body schema: application/json
effectiveDate
string

A datetime (ISO-8601 format) indicating the moment in time at which this specific ConsentDocument can become effective and might replace a previous version. The effectivedate cannot be set in the past. When a ConsentDocument is created with status=active, the effectiveDate is set to the current timestamp by default.

status
string
Default: "active"
Enum: "draft" "active"

The status of the ConsentDocument.

displayName
string

The human-readable name of the ConsentDocument.

version
string
language
string
processingPurpose
string
listOfAttributes
required
Array of strings
legalBasis
required
object

Responses

Request samples

Content type
application/json
{
  • "effectiveDate": "string",
  • "status": "draft",
  • "displayName": "string",
  • "version": "string",
  • "language": "string",
  • "processingPurpose": "string",
  • "listOfAttributes": [
    ],
  • "legalBasis": { }
}

Response samples

Content type
application/json
{ }

Create AttributeConsentDocument

Creates the AttributeConsentDocument specified by {documentId} in the AttributeConsentVersion {version} of AttributeConsentDefinition {definitionName}.

Authorizations:
bearer
path Parameters
definitionName
required
string

The identifier for the ConsentDefinition.

version
required
string

The identifier for the ConsentVersion.

documentId
required
string

The unique id that identifies an AttributeConsentDocument. It follows the format '{documentVersion}|{documentLanguage}'

tenant
required
string

Your tenant code.

query Parameters
refresh_user_details
boolean

Indicates whether the userinfo cache associated with the OneWelcome token is refreshed. By default, false.

header Parameters
acting-tenant-id
string

Tenant code. Used when not passing the tenant code in the URL path parameter

tenant-id
string

Tenant code. Used when not passing the tenant code in the URL path parameter or no acting tenant

Request Body schema: application/json
effectiveDate
string

A datetime (ISO-8601 format) indicating the moment in time at which this specific ConsentDocument can become effective and might replace a previous version. The effectivedate cannot be set in the past. When a ConsentDocument is created with status=active, the effectiveDate is set to the current timestamp by default.

status
string
Default: "active"
Enum: "draft" "active"

The status of the ConsentDocument.

displayName
string

The human-readable name of the ConsentDocument.

version
string
language
string
processingPurpose
string
listOfAttributes
required
Array of strings
legalBasis
required
object

Responses

Request samples

Content type
application/json
{
  • "effectiveDate": "string",
  • "status": "draft",
  • "displayName": "string",
  • "version": "string",
  • "language": "string",
  • "processingPurpose": "string",
  • "listOfAttributes": [
    ],
  • "legalBasis": { }
}

Response samples

Content type
application/json
{ }

Delete AttributeConsentDocument

Deletes the AttributeConsentDocument specified by {documentId} in the AttributeConsentVersion {version} of AttributeConsentDefinition {definitionName}.

Authorizations:
bearer
path Parameters
definitionName
required
string

The identifier for the ConsentDefinition.

version
required
string

The identifier for the ConsentVersion.

documentId
required
string

The unique id that identifies an AttributeConsentDocument. It follows the format '{documentVersion}|{documentLanguage}'

tenant
required
string

Your tenant code.

query Parameters
refresh_user_details
boolean

Indicates whether the userinfo cache associated with the OneWelcome token is refreshed. By default, false.

header Parameters
acting-tenant-id
string

Tenant code. Used when not passing the tenant code in the URL path parameter

tenant-id
string

Tenant code. Used when not passing the tenant code in the URL path parameter or no acting tenant

Responses

Response samples

Content type
application/json
{ }

Get AttributeConsentDocument

Returns the AttributeConsentDocument specified by {documentId} in AttributeConsentVersion {version} of AttributeConsentDefinition {definitionName}.

Authorizations:
bearer
path Parameters
definitionName
required
string

The identifier for the ConsentDefinition.

version
required
string

The identifier for the ConsentVersion.

documentId
required
string

The unique id that identifies an AttributeConsentDocument. It follows the format '{documentVersion}|{documentLanguage}'

tenant
required
string

Your tenant code.

query Parameters
refresh_user_details
boolean

Indicates whether the userinfo cache associated with the OneWelcome token is refreshed. By default, false.

header Parameters
acting-tenant-id
string

Tenant code. Used when not passing the tenant code in the URL path parameter

tenant-id
string

Tenant code. Used when not passing the tenant code in the URL path parameter or no acting tenant

Responses

Response samples

Content type
application/json
{
  • "config": {
    }
}

Update AttributeConsentDocument

Updates the AttributeConsentDocument specified by {documentId} in the AttributeConsentVersion {version} of AttributeConsentDefinition {definitionName}.

Note: A PUT request overwrites the original object. Be sure to (re-)enter the values for all desired properties.

Authorizations:
bearer
path Parameters
definitionName
required
string

The identifier for the ConsentDefinition.

version
required
string

The identifier for the ConsentVersion.

documentId
required
string

The unique id that identifies an AttributeConsentDocument. It follows the format '{documentVersion}|{documentLanguage}'

tenant
required
string

Your tenant code.

query Parameters
refresh_user_details
boolean

Indicates whether the userinfo cache associated with the OneWelcome token is refreshed. By default, false.

header Parameters
acting-tenant-id
string

Tenant code. Used when not passing the tenant code in the URL path parameter

tenant-id
string

Tenant code. Used when not passing the tenant code in the URL path parameter or no acting tenant

Request Body schema: application/json
effectiveDate
string

A datetime (ISO-8601 format) indicating the moment in time at which this specific ConsentDocument can become effective and might replace a previous version. The effectivedate cannot be set in the past. When a ConsentDocument is created with status=active, the effectiveDate is set to the current timestamp by default.

status
string
Default: "active"
Enum: "draft" "active"

The status of the ConsentDocument.

displayName
string

The human-readable name of the ConsentDocument.

version
string
language
string
processingPurpose
string
listOfAttributes
required
Array of strings
legalBasis
required
object

Responses

Request samples

Content type
application/json
{
  • "effectiveDate": "string",
  • "status": "draft",
  • "displayName": "string",
  • "version": "string",
  • "language": "string",
  • "processingPurpose": "string",
  • "listOfAttributes": [
    ],
  • "legalBasis": { }
}

Response samples

Content type
application/json
{ }

Create AttributeConsentDocument

Creates the AttributeConsentDocument specified by {documentId} in the AttributeConsentVersion {version} of AttributeConsentDefinition {definitionName}.

Authorizations:
bearer
path Parameters
definitionName
required
string

The identifier for the ConsentDefinition.

version
required
string

The identifier for the ConsentVersion.

documentId
required
string

The unique id that identifies an AttributeConsentDocument. It follows the format '{documentVersion}|{documentLanguage}'

tenant
required
string

Your tenant code.

query Parameters
refresh_user_details
boolean

Indicates whether the userinfo cache associated with the OneWelcome token is refreshed. By default, false.

header Parameters
acting-tenant-id
string

Tenant code. Used when not passing the tenant code in the URL path parameter

tenant-id
string

Tenant code. Used when not passing the tenant code in the URL path parameter or no acting tenant

Request Body schema: application/json
effectiveDate
string

A datetime (ISO-8601 format) indicating the moment in time at which this specific ConsentDocument can become effective and might replace a previous version. The effectivedate cannot be set in the past. When a ConsentDocument is created with status=active, the effectiveDate is set to the current timestamp by default.

status
string
Default: "active"
Enum: "draft" "active"

The status of the ConsentDocument.

displayName
string

The human-readable name of the ConsentDocument.

version
string
language
string
processingPurpose
string
listOfAttributes
required
Array of strings
legalBasis
required
object

Responses

Request samples

Content type
application/json
{
  • "effectiveDate": "string",
  • "status": "draft",
  • "displayName": "string",
  • "version": "string",
  • "language": "string",
  • "processingPurpose": "string",
  • "listOfAttributes": [
    ],
  • "legalBasis": { }
}

Response samples

Content type
application/json
{ }

Delete AttributeConsentDocument

Deletes the AttributeConsentDocument specified by {documentId} in the AttributeConsentVersion {version} of AttributeConsentDefinition {definitionName}.

Authorizations:
bearer
path Parameters
definitionName
required
string

The identifier for the ConsentDefinition.

version
required
string

The identifier for the ConsentVersion.

documentId
required
string

The unique id that identifies an AttributeConsentDocument. It follows the format '{documentVersion}|{documentLanguage}'

tenant
required
string

Your tenant code.

query Parameters
refresh_user_details
boolean

Indicates whether the userinfo cache associated with the OneWelcome token is refreshed. By default, false.

header Parameters
acting-tenant-id
string

Tenant code. Used when not passing the tenant code in the URL path parameter

tenant-id
string

Tenant code. Used when not passing the tenant code in the URL path parameter or no acting tenant

Responses

Response samples

Content type
application/json
{ }

List all ConsentDefinitions

Lists all defined ConsentDefinitions.

Authorizations:
bearer
path Parameters
tenant
required
string

Your tenant code.

query Parameters
details
required
any

Indicates whether the complete config of the requested objects is included in the response.

refresh_user_details
boolean

Indicates whether the userinfo cache associated with the OneWelcome token is refreshed. By default, false.

header Parameters
acting-tenant-id
string

Tenant code. Used when not passing the tenant code in the URL path parameter

tenant-id
string

Tenant code. Used when not passing the tenant code in the URL path parameter or no acting tenant

Responses

Response samples

Content type
application/json
{
  • "resources": [
    ],
  • "config": [
    ]
}

List all ConsentDefinitions

Lists all defined ConsentDefinitions.

Authorizations:
bearer
path Parameters
tenant
required
string

Your tenant code.

query Parameters
details
required
any

Indicates whether the complete config of the requested objects is included in the response.

refresh_user_details
boolean

Indicates whether the userinfo cache associated with the OneWelcome token is refreshed. By default, false.

header Parameters
acting-tenant-id
string

Tenant code. Used when not passing the tenant code in the URL path parameter

tenant-id
string

Tenant code. Used when not passing the tenant code in the URL path parameter or no acting tenant

Responses

Response samples

Content type
application/json
{
  • "resources": [
    ],
  • "config": [
    ]
}

Get ConsentDefinition

Returns the ConsentDefinition specified by {definitionName}.

Authorizations:
bearer
path Parameters
definitionName
required
string

The identifier for the ConsentDefinition.

tenant
required
string

Your tenant code.

query Parameters
refresh_user_details
boolean

Indicates whether the userinfo cache associated with the OneWelcome token is refreshed. By default, false.

header Parameters
acting-tenant-id
string

Tenant code. Used when not passing the tenant code in the URL path parameter

tenant-id
string

Tenant code. Used when not passing the tenant code in the URL path parameter or no acting tenant

Responses

Response samples

Content type
application/json
{
  • "resources": [
    ],
  • "config": {
    }
}

Create ConsentDefinition

Creates the ConsentDefinition specified by {definitionName}.

Authorizations:
bearer
path Parameters
definitionName
required
string

The identifier for the ConsentDefinition.

tenant
required
string

Your tenant code.

query Parameters
refresh_user_details
boolean

Indicates whether the userinfo cache associated with the OneWelcome token is refreshed. By default, false.

header Parameters
acting-tenant-id
string

Tenant code. Used when not passing the tenant code in the URL path parameter

tenant-id
string

Tenant code. Used when not passing the tenant code in the URL path parameter or no acting tenant

Request Body schema: application/json
type
string
Default: "document"
Enum: "document" "attribute"
description
string
displayName
string

Responses

Request samples

Content type
application/json
{
  • "type": "document",
  • "description": "string",
  • "displayName": "string"
}

Response samples

Content type
application/json
{ }

Create/update ConsentDefinition

Creates or updates the ConsentDefinition specified by {definitionName}.

Note: A PUT request overwrites the original object. Be sure to (re-)enter the values for all desired properties.

Authorizations:
bearer
path Parameters
definitionName
required
string

The identifier for the ConsentDefinition.

tenant
required
string

Your tenant code.

query Parameters
refresh_user_details
boolean

Indicates whether the userinfo cache associated with the OneWelcome token is refreshed. By default, false.

header Parameters
acting-tenant-id
string

Tenant code. Used when not passing the tenant code in the URL path parameter

tenant-id
string

Tenant code. Used when not passing the tenant code in the URL path parameter or no acting tenant

Request Body schema: application/json
type
string
Default: "document"
Enum: "document" "attribute"
description
string
displayName
string

Responses

Request samples

Content type
application/json
{
  • "type": "document",
  • "description": "string",
  • "displayName": "string"
}

Response samples

Content type
application/json
{ }

Delete ConsentDefinition

Deletes the ConsentDefinition specified by {definitionName}.

Authorizations:
bearer
path Parameters
definitionName
required
string

The identifier for the ConsentDefinition.

tenant
required
string

Your tenant code.

query Parameters
refresh_user_details
boolean

Indicates whether the userinfo cache associated with the OneWelcome token is refreshed. By default, false.

header Parameters
acting-tenant-id
string

Tenant code. Used when not passing the tenant code in the URL path parameter

tenant-id
string

Tenant code. Used when not passing the tenant code in the URL path parameter or no acting tenant

Responses

Response samples

Content type
application/json
{ }

Get ConsentDefinition

Returns the ConsentDefinition specified by {definitionName}.

Authorizations:
bearer
path Parameters
definitionName
required
string

The identifier for the ConsentDefinition.

tenant
required
string

Your tenant code.

query Parameters
refresh_user_details
boolean

Indicates whether the userinfo cache associated with the OneWelcome token is refreshed. By default, false.

header Parameters
acting-tenant-id
string

Tenant code. Used when not passing the tenant code in the URL path parameter

tenant-id
string

Tenant code. Used when not passing the tenant code in the URL path parameter or no acting tenant

Responses

Response samples

Content type
application/json
{
  • "resources": [
    ],
  • "config": {
    }
}

Create ConsentDefinition

Creates the ConsentDefinition specified by {definitionName}.

Authorizations:
bearer
path Parameters
definitionName
required
string

The identifier for the ConsentDefinition.

tenant
required
string

Your tenant code.

query Parameters
refresh_user_details
boolean

Indicates whether the userinfo cache associated with the OneWelcome token is refreshed. By default, false.

header Parameters
acting-tenant-id
string

Tenant code. Used when not passing the tenant code in the URL path parameter

tenant-id
string

Tenant code. Used when not passing the tenant code in the URL path parameter or no acting tenant

Request Body schema: application/json
type
string
Default: "document"
Enum: "document" "attribute"
description
string
displayName
string

Responses

Request samples

Content type
application/json
{
  • "type": "document",
  • "description": "string",
  • "displayName": "string"
}

Response samples

Content type
application/json
{ }

Create/update ConsentDefinition

Creates or updates the ConsentDefinition specified by {definitionName}.

Note: A PUT request overwrites the original object. Be sure to (re-)enter the values for all desired properties.

Authorizations:
bearer
path Parameters
definitionName
required
string

The identifier for the ConsentDefinition.

tenant
required
string

Your tenant code.

query Parameters
refresh_user_details
boolean

Indicates whether the userinfo cache associated with the OneWelcome token is refreshed. By default, false.

header Parameters
acting-tenant-id
string

Tenant code. Used when not passing the tenant code in the URL path parameter

tenant-id
string

Tenant code. Used when not passing the tenant code in the URL path parameter or no acting tenant

Request Body schema: application/json
type
string
Default: "document"
Enum: "document" "attribute"
description
string
displayName
string

Responses

Request samples

Content type
application/json
{
  • "type": "document",
  • "description": "string",
  • "displayName": "string"
}

Response samples

Content type
application/json
{ }

Delete ConsentDefinition

Deletes the ConsentDefinition specified by {definitionName}.

Authorizations:
bearer
path Parameters
definitionName
required
string

The identifier for the ConsentDefinition.

tenant
required
string

Your tenant code.

query Parameters
refresh_user_details
boolean

Indicates whether the userinfo cache associated with the OneWelcome token is refreshed. By default, false.

header Parameters
acting-tenant-id
string

Tenant code. Used when not passing the tenant code in the URL path parameter

tenant-id
string

Tenant code. Used when not passing the tenant code in the URL path parameter or no acting tenant

Responses

Response samples

Content type
application/json
{ }

List all ConsentVersions

Lists all ConsentVersions of ConsentDefinition {definitionName}.

Authorizations:
bearer
path Parameters
definitionName
required
string

The identifier for the ConsentDefinition.

tenant
required
string

Your tenant code.

query Parameters
details
required
any

Indicates whether the complete config of the requested objects is included in the response.

refresh_user_details
boolean

Indicates whether the userinfo cache associated with the OneWelcome token is refreshed. By default, false.

header Parameters
acting-tenant-id
string

Tenant code. Used when not passing the tenant code in the URL path parameter

tenant-id
string

Tenant code. Used when not passing the tenant code in the URL path parameter or no acting tenant

Responses

Response samples

Content type
application/json
{
  • "resources": [
    ],
  • "config": [
    ]
}

List all ConsentVersions

Lists all ConsentVersions of ConsentDefinition {definitionName}.

Authorizations:
bearer
path Parameters
definitionName
required
string

The identifier for the ConsentDefinition.

tenant
required
string

Your tenant code.

query Parameters
details
required
any

Indicates whether the complete config of the requested objects is included in the response.

refresh_user_details
boolean

Indicates whether the userinfo cache associated with the OneWelcome token is refreshed. By default, false.

header Parameters
acting-tenant-id
string

Tenant code. Used when not passing the tenant code in the URL path parameter

tenant-id
string

Tenant code. Used when not passing the tenant code in the URL path parameter or no acting tenant

Responses

Response samples

Content type
application/json
{
  • "resources": [
    ],
  • "config": [
    ]
}

Get ConsentVersion

Returns ConsentVersion {version} of ConsentDefinition {definitionName}.

Authorizations:
bearer
path Parameters
definitionName
required
string

The identifier for the ConsentDefinition.

version
required
string

The identifier for the ConsentVersion.

tenant
required
string

Your tenant code.

query Parameters
refresh_user_details
boolean

Indicates whether the userinfo cache associated with the OneWelcome token is refreshed. By default, false.

header Parameters
acting-tenant-id
string

Tenant code. Used when not passing the tenant code in the URL path parameter

tenant-id
string

Tenant code. Used when not passing the tenant code in the URL path parameter or no acting tenant

Responses

Response samples

Content type
application/json
{
  • "resources": [
    ],
  • "config": {
    }
}

Create/update ConsentVersion

Creates or updates ConsentVersion {version} of ConsentDefinition {definitionName}.

Note: A PUT request overwrites the original object. Be sure to (re-)enter the values for all desired properties.

Authorizations:
bearer
path Parameters
definitionName
required
string

The identifier for the ConsentDefinition.

version
required
string

The identifier for the ConsentVersion.

tenant
required
string

Your tenant code.

query Parameters
refresh_user_details
boolean

Indicates whether the userinfo cache associated with the OneWelcome token is refreshed. By default, false.

header Parameters
acting-tenant-id
string

Tenant code. Used when not passing the tenant code in the URL path parameter

tenant-id
string

Tenant code. Used when not passing the tenant code in the URL path parameter or no acting tenant

Request Body schema: application/json
required
Array of objects (OptInConfigRequest)
description
string
displayName
string

Responses

Request samples

Content type
application/json
{
  • "optInConfig": [
    ],
  • "description": "string",
  • "displayName": "string"
}

Response samples

Content type
application/json
{ }

Create ConsentVersion

Creates the ConsentVersion {version} of ConsentDefinition {definitionName}.

Authorizations:
bearer
path Parameters
definitionName
required
string

The identifier for the ConsentDefinition.

version
required
string

The identifier for the ConsentVersion.

tenant
required
string

Your tenant code.

query Parameters
refresh_user_details
boolean

Indicates whether the userinfo cache associated with the OneWelcome token is refreshed. By default, false.

header Parameters
acting-tenant-id
string

Tenant code. Used when not passing the tenant code in the URL path parameter

tenant-id
string

Tenant code. Used when not passing the tenant code in the URL path parameter or no acting tenant

Request Body schema: application/json
required
Array of objects (OptInConfigRequest)
description
string
displayName
string

Responses

Request samples

Content type
application/json
{
  • "optInConfig": [
    ],
  • "description": "string",
  • "displayName": "string"
}

Response samples

Content type
application/json
{ }

Delete ConsentVersion

Deletes the ConsentVersion {version} of ConsentDefinition {definitionName}.

Authorizations:
bearer
path Parameters
definitionName
required
string

The identifier for the ConsentDefinition.

version
required
string

The identifier for the ConsentVersion.

tenant
required
string

Your tenant code.

query Parameters
refresh_user_details
boolean

Indicates whether the userinfo cache associated with the OneWelcome token is refreshed. By default, false.

header Parameters
acting-tenant-id
string

Tenant code. Used when not passing the tenant code in the URL path parameter

tenant-id
string

Tenant code. Used when not passing the tenant code in the URL path parameter or no acting tenant

Responses

Response samples

Content type
application/json
{ }

Get ConsentVersion

Returns ConsentVersion {version} of ConsentDefinition {definitionName}.

Authorizations:
bearer
path Parameters
definitionName
required
string

The identifier for the ConsentDefinition.

version
required
string

The identifier for the ConsentVersion.

tenant
required
string

Your tenant code.

query Parameters
refresh_user_details
boolean

Indicates whether the userinfo cache associated with the OneWelcome token is refreshed. By default, false.

header Parameters
acting-tenant-id
string

Tenant code. Used when not passing the tenant code in the URL path parameter

tenant-id
string

Tenant code. Used when not passing the tenant code in the URL path parameter or no acting tenant

Responses

Response samples

Content type
application/json
{
  • "resources": [
    ],
  • "config": {
    }
}

Create/update ConsentVersion

Creates or updates ConsentVersion {version} of ConsentDefinition {definitionName}.

Note: A PUT request overwrites the original object. Be sure to (re-)enter the values for all desired properties.

Authorizations:
bearer
path Parameters
definitionName
required
string

The identifier for the ConsentDefinition.

version
required
string

The identifier for the ConsentVersion.

tenant
required
string

Your tenant code.

query Parameters
refresh_user_details
boolean

Indicates whether the userinfo cache associated with the OneWelcome token is refreshed. By default, false.

header Parameters
acting-tenant-id
string

Tenant code. Used when not passing the tenant code in the URL path parameter

tenant-id
string

Tenant code. Used when not passing the tenant code in the URL path parameter or no acting tenant

Request Body schema: application/json
required
Array of objects (OptInConfigRequest)
description
string
displayName
string

Responses

Request samples

Content type
application/json
{
  • "optInConfig": [
    ],
  • "description": "string",
  • "displayName": "string"
}

Response samples

Content type
application/json
{ }

Create ConsentVersion

Creates the ConsentVersion {version} of ConsentDefinition {definitionName}.

Authorizations:
bearer
path Parameters
definitionName
required
string

The identifier for the ConsentDefinition.

version
required
string

The identifier for the ConsentVersion.

tenant
required
string

Your tenant code.

query Parameters
refresh_user_details
boolean

Indicates whether the userinfo cache associated with the OneWelcome token is refreshed. By default, false.

header Parameters
acting-tenant-id
string

Tenant code. Used when not passing the tenant code in the URL path parameter

tenant-id
string

Tenant code. Used when not passing the tenant code in the URL path parameter or no acting tenant

Request Body schema: application/json
required
Array of objects (OptInConfigRequest)
description
string
displayName
string

Responses

Request samples

Content type
application/json
{
  • "optInConfig": [
    ],
  • "description": "string",
  • "displayName": "string"
}

Response samples

Content type
application/json
{ }

Delete ConsentVersion

Deletes the ConsentVersion {version} of ConsentDefinition {definitionName}.

Authorizations:
bearer
path Parameters
definitionName
required
string

The identifier for the ConsentDefinition.

version
required
string

The identifier for the ConsentVersion.

tenant
required
string

Your tenant code.

query Parameters
refresh_user_details
boolean

Indicates whether the userinfo cache associated with the OneWelcome token is refreshed. By default, false.

header Parameters
acting-tenant-id
string

Tenant code. Used when not passing the tenant code in the URL path parameter

tenant-id
string

Tenant code. Used when not passing the tenant code in the URL path parameter or no acting tenant

Responses

Response samples

Content type
application/json
{ }

Get endOfLife of ConsentVersion

Returns the endOfLife associated with the ConsentVersion {version} of ConsentDefinition {definitionName}.

Authorizations:
bearer
path Parameters
definitionName
required
string

The identifier for the ConsentDefinition.

version
required
string

The identifier for the ConsentVersion.

tenant
required
string

Your tenant code.

query Parameters
refresh_user_details
boolean

Indicates whether the userinfo cache associated with the OneWelcome token is refreshed. By default, false.

header Parameters
acting-tenant-id
string

Tenant code. Used when not passing the tenant code in the URL path parameter

tenant-id
string

Tenant code. Used when not passing the tenant code in the URL path parameter or no acting tenant

Responses

Response samples

Content type
application/json
{
  • "config": {
    }
}

Create/update EndOfLife of ConsentVersion

Creates or updates the endOfLife associated with the ConsentVersion {version} of ConsentDefinition {definitionName}.

Note: A PUT request overwrites the original object. Be sure to (re-)enter the values for all desired properties.

Authorizations:
bearer
path Parameters
definitionName
required
string

The identifier for the ConsentDefinition.

version
required
string

The identifier for the ConsentVersion.

tenant
required
string

Your tenant code.

query Parameters
refresh_user_details
boolean

Indicates whether the userinfo cache associated with the OneWelcome token is refreshed. By default, false.

header Parameters
acting-tenant-id
string

Tenant code. Used when not passing the tenant code in the URL path parameter

tenant-id
string

Tenant code. Used when not passing the tenant code in the URL path parameter or no acting tenant

Request Body schema: application/json
startDate
required
string

A datetime (ISO-8601 format) indicating the first moment in time that users can receive notifications to report the termination of the associated ConsentVersion. This notification should include an invitation to accept the new version of the consent. startDate can only be set to a future moment in time and must lie before endDate.

endDate
required
string

A datetime (ISO-8601 format) indicating the last moment in time that a ConsentDocument of the associated ConsentVersion can be valid.

gracePeriod
required
string

A duration (ISO-8601 period format) indicating the period the user gets to agree to the new active ConsentDocument. This period starts the moment the user receives the first invitation to accept this new ConsentDocument. The actual grace period for a specific user is never extended beyond the endDate.

Responses

Request samples

Content type
application/json
{
  • "startDate": "string",
  • "endDate": "string",
  • "gracePeriod": "string"
}

Response samples

Content type
application/json
{ }

Delete EndOfLife of ConsentVersion

Deletes the endOfLife associated with the ConsentVersion {version} of ConsentDefinition {definitionName}.

Authorizations:
bearer
path Parameters
definitionName
required
string

The identifier for the ConsentDefinition.

version
required
string

The identifier for the ConsentVersion.

tenant
required
string

Your tenant code.

query Parameters
refresh_user_details
boolean

Indicates whether the userinfo cache associated with the OneWelcome token is refreshed. By default, false.

header Parameters
acting-tenant-id
string

Tenant code. Used when not passing the tenant code in the URL path parameter

tenant-id
string

Tenant code. Used when not passing the tenant code in the URL path parameter or no acting tenant

Responses

Response samples

Content type
application/json
{ }

Get endOfLife of ConsentVersion

Returns the endOfLife associated with the ConsentVersion {version} of ConsentDefinition {definitionName}.

Authorizations:
bearer
path Parameters
definitionName
required
string

The identifier for the ConsentDefinition.

version
required
string

The identifier for the ConsentVersion.

tenant
required
string

Your tenant code.

query Parameters
refresh_user_details
boolean

Indicates whether the userinfo cache associated with the OneWelcome token is refreshed. By default, false.

header Parameters
acting-tenant-id
string

Tenant code. Used when not passing the tenant code in the URL path parameter

tenant-id
string

Tenant code. Used when not passing the tenant code in the URL path parameter or no acting tenant

Responses

Response samples

Content type
application/json
{
  • "config": {
    }
}

Create/update EndOfLife of ConsentVersion

Creates or updates the endOfLife associated with the ConsentVersion {version} of ConsentDefinition {definitionName}.

Note: A PUT request overwrites the original object. Be sure to (re-)enter the values for all desired properties.

Authorizations:
bearer
path Parameters
definitionName
required
string

The identifier for the ConsentDefinition.

version
required
string

The identifier for the ConsentVersion.

tenant
required
string

Your tenant code.

query Parameters
refresh_user_details
boolean

Indicates whether the userinfo cache associated with the OneWelcome token is refreshed. By default, false.

header Parameters
acting-tenant-id
string

Tenant code. Used when not passing the tenant code in the URL path parameter

tenant-id
string

Tenant code. Used when not passing the tenant code in the URL path parameter or no acting tenant

Request Body schema: application/json
startDate
required
string

A datetime (ISO-8601 format) indicating the first moment in time that users can receive notifications to report the termination of the associated ConsentVersion. This notification should include an invitation to accept the new version of the consent. startDate can only be set to a future moment in time and must lie before endDate.

endDate
required
string

A datetime (ISO-8601 format) indicating the last moment in time that a ConsentDocument of the associated ConsentVersion can be valid.

gracePeriod
required
string

A duration (ISO-8601 period format) indicating the period the user gets to agree to the new active ConsentDocument. This period starts the moment the user receives the first invitation to accept this new ConsentDocument. The actual grace period for a specific user is never extended beyond the endDate.

Responses

Request samples

Content type
application/json
{
  • "startDate": "string",
  • "endDate": "string",
  • "gracePeriod": "string"
}

Response samples

Content type
application/json
{ }

Delete EndOfLife of ConsentVersion

Deletes the endOfLife associated with the ConsentVersion {version} of ConsentDefinition {definitionName}.

Authorizations:
bearer
path Parameters
definitionName
required
string

The identifier for the ConsentDefinition.

version
required
string

The identifier for the ConsentVersion.

tenant
required
string

Your tenant code.

query Parameters
refresh_user_details
boolean

Indicates whether the userinfo cache associated with the OneWelcome token is refreshed. By default, false.

header Parameters
acting-tenant-id
string

Tenant code. Used when not passing the tenant code in the URL path parameter

tenant-id
string

Tenant code. Used when not passing the tenant code in the URL path parameter or no acting tenant

Responses

Response samples

Content type
application/json
{ }

List all ConsentDocument languages

Lists all languages for which ConsentDocuments exist in ConsentVersion {version} of ConsentDocument {definitionName}.

Authorizations:
bearer
path Parameters
definitionName
required
string

The identifier for the ConsentDefinition.

version
required
string

The identifier for the ConsentVersion.

tenant
required
string

Your tenant code.

query Parameters
details
required
any

Indicates whether the complete config of the requested objects is included in the response.

refresh_user_details
boolean

Indicates whether the userinfo cache associated with the OneWelcome token is refreshed. By default, false.

header Parameters
acting-tenant-id
string

Tenant code. Used when not passing the tenant code in the URL path parameter

tenant-id
string

Tenant code. Used when not passing the tenant code in the URL path parameter or no acting tenant

Responses

Response samples

Content type
application/json
{
  • "resources": [
    ]
}

List all ConsentDocument languages

Lists all languages for which ConsentDocuments exist in ConsentVersion {version} of ConsentDocument {definitionName}.

Authorizations:
bearer
path Parameters
definitionName
required
string

The identifier for the ConsentDefinition.

version
required
string

The identifier for the ConsentVersion.

tenant
required
string

Your tenant code.

query Parameters
details
required
any

Indicates whether the complete config of the requested objects is included in the response.

refresh_user_details
boolean

Indicates whether the userinfo cache associated with the OneWelcome token is refreshed. By default, false.

header Parameters
acting-tenant-id
string

Tenant code. Used when not passing the tenant code in the URL path parameter

tenant-id
string

Tenant code. Used when not passing the tenant code in the URL path parameter or no acting tenant

Responses

Response samples

Content type
application/json
{
  • "resources": [
    ]
}

List all ConsentDocuments for one language

Lists all ConsentDocuments in {language} in ConsentVersion {version} of ConsentDocument {definitionName}.

Authorizations:
bearer
path Parameters
definitionName
required
string

The identifier for the ConsentDefinition.

version
required
string

The identifier for the ConsentVersion.

language
required
string

An identifier to specify the audience (based on characteristics such as language and country of residence) for which the ConsentDocument applies.

tenant
required
string

Your tenant code.

query Parameters
details
required
any

Indicates whether the complete config of the requested objects is included in the response.

refresh_user_details
boolean

Indicates whether the userinfo cache associated with the OneWelcome token is refreshed. By default, false.

header Parameters
acting-tenant-id
string

Tenant code. Used when not passing the tenant code in the URL path parameter

tenant-id
string

Tenant code. Used when not passing the tenant code in the URL path parameter or no acting tenant

Responses

Response samples

Content type
application/json
{
  • "resources": [
    ],
  • "config": [
    ]
}

List all ConsentDocuments for one language

Lists all ConsentDocuments in {language} in ConsentVersion {version} of ConsentDocument {definitionName}.

Authorizations:
bearer
path Parameters
definitionName
required
string

The identifier for the ConsentDefinition.

version
required
string

The identifier for the ConsentVersion.

language
required
string

An identifier to specify the audience (based on characteristics such as language and country of residence) for which the ConsentDocument applies.

tenant
required
string

Your tenant code.

query Parameters
details
required
any

Indicates whether the complete config of the requested objects is included in the response.

refresh_user_details
boolean

Indicates whether the userinfo cache associated with the OneWelcome token is refreshed. By default, false.

header Parameters
acting-tenant-id
string

Tenant code. Used when not passing the tenant code in the URL path parameter

tenant-id
string

Tenant code. Used when not passing the tenant code in the URL path parameter or no acting tenant

Responses

Response samples

Content type
application/json
{
  • "resources": [
    ],
  • "config": [
    ]
}

Get ConsentDocument

Returns the ConsentDocument specified by {language} and {documentVersion} in ConsentVersion {version} of ConsentDefinition {definitionName}.

Authorizations:
bearer
path Parameters
definitionName
required
string

The identifier for the ConsentDefinition.

version
required
string

The identifier for the ConsentVersion.

language
required
string

An identifier to specify the audience (based on characteristics such as language and country of residence) for which the ConsentDocument applies.

documentVersion
required
string

An identifier for the ConsentDocument. The ConsentDocument is uniquely identified within the context of the ConsentVersion by the combination of language and documentVersion.

tenant
required
string

Your tenant code.

query Parameters
refresh_user_details
boolean

Indicates whether the userinfo cache associated with the OneWelcome token is refreshed. By default, false.

header Parameters
acting-tenant-id
string

Tenant code. Used when not passing the tenant code in the URL path parameter

tenant-id
string

Tenant code. Used when not passing the tenant code in the URL path parameter or no acting tenant

Responses

Response samples

Content type
application/json
{
  • "config": {
    }
}

Create/update ConsentDocument

Creates or updates the ConsentDocument specified by {language} and {documentversion} in the ConsentVersion {version} of ConsentDefinition {definitionName}.

Note: A PUT request overwrites the original object. Be sure to (re-)enter the values for all desired properties.

Authorizations:
bearer
path Parameters
definitionName
required
string

The identifier for the ConsentDefinition.

version
required
string

The identifier for the ConsentVersion.

language
required
string

An identifier to specify the audience (based on characteristics such as language and country of residence) for which the ConsentDocument applies.

documentVersion
required
string

An identifier for the ConsentDocument. The ConsentDocument is uniquely identified within the context of the ConsentVersion by the combination of language and documentVersion.

tenant
required
string

Your tenant code.

query Parameters
refresh_user_details
boolean

Indicates whether the userinfo cache associated with the OneWelcome token is refreshed. By default, false.

header Parameters
acting-tenant-id
string

Tenant code. Used when not passing the tenant code in the URL path parameter

tenant-id
string

Tenant code. Used when not passing the tenant code in the URL path parameter or no acting tenant

Request Body schema: application/json
effectiveDate
string

A datetime (ISO-8601 format) indicating the moment in time at which this specific ConsentDocument can become effective and might replace a previous version. The effectivedate cannot be set in the past. When a ConsentDocument is created with status=active, the effectiveDate is set to the current timestamp by default.

status
string
Default: "active"
Enum: "draft" "active"

The status of the ConsentDocument.

description
string

The description of the ConsentDocument.

url
string

A URL which can be used to share the content of the ConsentDocument with the user.

displayName
string

The human-readable name of the ConsentDocument.

mandatory
boolean
Default: false

Whether or not the consent should be marked as mandatory.

Responses

Request samples

Content type
application/json
{
  • "effectiveDate": "string",
  • "status": "draft",
  • "description": "string",
  • "url": "string",
  • "displayName": "string",
  • "mandatory": false
}

Response samples

Content type
application/json
{ }

Create ConsentDocument

Creates or updates the ConsentDocument specified by {language} and {documentversion} in the ConsentVersion {version} of ConsentDefinition {definitionName}.

Authorizations:
bearer
path Parameters
definitionName
required
string

The identifier for the ConsentDefinition.

version
required
string

The identifier for the ConsentVersion.

language
required
string

An identifier to specify the audience (based on characteristics such as language and country of residence) for which the ConsentDocument applies.

documentVersion
required
string

An identifier for the ConsentDocument. The ConsentDocument is uniquely identified within the context of the ConsentVersion by the combination of language and documentVersion.

tenant
required
string

Your tenant code.

query Parameters
refresh_user_details
boolean

Indicates whether the userinfo cache associated with the OneWelcome token is refreshed. By default, false.

header Parameters
acting-tenant-id
string

Tenant code. Used when not passing the tenant code in the URL path parameter

tenant-id
string

Tenant code. Used when not passing the tenant code in the URL path parameter or no acting tenant

Request Body schema: application/json
effectiveDate
string

A datetime (ISO-8601 format) indicating the moment in time at which this specific ConsentDocument can become effective and might replace a previous version. The effectivedate cannot be set in the past. When a ConsentDocument is created with status=active, the effectiveDate is set to the current timestamp by default.

status
string
Default: "active"
Enum: "draft" "active"

The status of the ConsentDocument.

description
string

The description of the ConsentDocument.

url
string

A URL which can be used to share the content of the ConsentDocument with the user.

displayName
string

The human-readable name of the ConsentDocument.

mandatory
boolean
Default: false

Whether or not the consent should be marked as mandatory.

Responses

Request samples

Content type
application/json
{
  • "effectiveDate": "string",
  • "status": "draft",
  • "description": "string",
  • "url": "string",
  • "displayName": "string",
  • "mandatory": false
}

Response samples

Content type
application/json
{ }

Delete ConsentDocument

Deletes the ConsentDocument specified by {language} and {documentversion} in the ConsentVersion {version} of ConsentDefinition {definitionName}.

Authorizations:
bearer
path Parameters
definitionName
required
string

The identifier for the ConsentDefinition.

version
required
string

The identifier for the ConsentVersion.

language
required
string
documentVersion
required
string

An identifier for the ConsentDocument. The ConsentDocument is uniquely identified within the context of the ConsentVersion by the combination of language and documentVersion.

tenant
required
string

Your tenant code.

query Parameters
refresh_user_details
boolean

Indicates whether the userinfo cache associated with the OneWelcome token is refreshed. By default, false.

header Parameters
acting-tenant-id
string

Tenant code. Used when not passing the tenant code in the URL path parameter

tenant-id
string

Tenant code. Used when not passing the tenant code in the URL path parameter or no acting tenant

Responses

Response samples

Content type
application/json
{ }

Get ConsentDocument

Returns the ConsentDocument specified by {language} and {documentVersion} in ConsentVersion {version} of ConsentDefinition {definitionName}.

Authorizations:
bearer
path Parameters
definitionName
required
string

The identifier for the ConsentDefinition.

version
required
string

The identifier for the ConsentVersion.

language
required
string

An identifier to specify the audience (based on characteristics such as language and country of residence) for which the ConsentDocument applies.

documentVersion
required
string

An identifier for the ConsentDocument. The ConsentDocument is uniquely identified within the context of the ConsentVersion by the combination of language and documentVersion.

tenant
required
string

Your tenant code.

query Parameters
refresh_user_details
boolean

Indicates whether the userinfo cache associated with the OneWelcome token is refreshed. By default, false.

header Parameters
acting-tenant-id
string

Tenant code. Used when not passing the tenant code in the URL path parameter

tenant-id
string

Tenant code. Used when not passing the tenant code in the URL path parameter or no acting tenant

Responses

Response samples

Content type
application/json
{
  • "config": {
    }
}

Create/update ConsentDocument

Creates or updates the ConsentDocument specified by {language} and {documentversion} in the ConsentVersion {version} of ConsentDefinition {definitionName}.

Note: A PUT request overwrites the original object. Be sure to (re-)enter the values for all desired properties.

Authorizations:
bearer
path Parameters
definitionName
required
string

The identifier for the ConsentDefinition.

version
required
string

The identifier for the ConsentVersion.

language
required
string

An identifier to specify the audience (based on characteristics such as language and country of residence) for which the ConsentDocument applies.

documentVersion
required
string

An identifier for the ConsentDocument. The ConsentDocument is uniquely identified within the context of the ConsentVersion by the combination of language and documentVersion.

tenant
required
string

Your tenant code.

query Parameters
refresh_user_details
boolean

Indicates whether the userinfo cache associated with the OneWelcome token is refreshed. By default, false.

header Parameters
acting-tenant-id
string

Tenant code. Used when not passing the tenant code in the URL path parameter

tenant-id
string

Tenant code. Used when not passing the tenant code in the URL path parameter or no acting tenant

Request Body schema: application/json
effectiveDate
string

A datetime (ISO-8601 format) indicating the moment in time at which this specific ConsentDocument can become effective and might replace a previous version. The effectivedate cannot be set in the past. When a ConsentDocument is created with status=active, the effectiveDate is set to the current timestamp by default.

status
string
Default: "active"
Enum: "draft" "active"

The status of the ConsentDocument.

description
string

The description of the ConsentDocument.

url
string

A URL which can be used to share the content of the ConsentDocument with the user.

displayName
string

The human-readable name of the ConsentDocument.

mandatory
boolean
Default: false

Whether or not the consent should be marked as mandatory.

Responses

Request samples

Content type
application/json
{
  • "effectiveDate": "string",
  • "status": "draft",
  • "description": "string",
  • "url": "string",
  • "displayName": "string",
  • "mandatory": false
}

Response samples

Content type
application/json
{ }

Create ConsentDocument

Creates or updates the ConsentDocument specified by {language} and {documentversion} in the ConsentVersion {version} of ConsentDefinition {definitionName}.

Authorizations:
bearer
path Parameters
definitionName
required
string

The identifier for the ConsentDefinition.

version
required
string

The identifier for the ConsentVersion.

language
required
string

An identifier to specify the audience (based on characteristics such as language and country of residence) for which the ConsentDocument applies.

documentVersion
required
string

An identifier for the ConsentDocument. The ConsentDocument is uniquely identified within the context of the ConsentVersion by the combination of language and documentVersion.

tenant
required
string

Your tenant code.

query Parameters
refresh_user_details
boolean

Indicates whether the userinfo cache associated with the OneWelcome token is refreshed. By default, false.

header Parameters
acting-tenant-id
string

Tenant code. Used when not passing the tenant code in the URL path parameter

tenant-id
string

Tenant code. Used when not passing the tenant code in the URL path parameter or no acting tenant

Request Body schema: application/json
effectiveDate
string

A datetime (ISO-8601 format) indicating the moment in time at which this specific ConsentDocument can become effective and might replace a previous version. The effectivedate cannot be set in the past. When a ConsentDocument is created with status=active, the effectiveDate is set to the current timestamp by default.

status
string
Default: "active"
Enum: "draft" "active"

The status of the ConsentDocument.

description
string

The description of the ConsentDocument.

url
string

A URL which can be used to share the content of the ConsentDocument with the user.

displayName
string

The human-readable name of the ConsentDocument.

mandatory
boolean
Default: false

Whether or not the consent should be marked as mandatory.

Responses

Request samples

Content type
application/json
{
  • "effectiveDate": "string",
  • "status": "draft",
  • "description": "string",
  • "url": "string",
  • "displayName": "string",
  • "mandatory": false
}

Response samples

Content type
application/json
{ }

Delete ConsentDocument

Deletes the ConsentDocument specified by {language} and {documentversion} in the ConsentVersion {version} of ConsentDefinition {definitionName}.

Authorizations:
bearer
path Parameters
definitionName
required
string

The identifier for the ConsentDefinition.

version
required
string

The identifier for the ConsentVersion.

language
required
string
documentVersion
required
string

An identifier for the ConsentDocument. The ConsentDocument is uniquely identified within the context of the ConsentVersion by the combination of language and documentVersion.

tenant
required
string

Your tenant code.

query Parameters
refresh_user_details
boolean

Indicates whether the userinfo cache associated with the OneWelcome token is refreshed. By default, false.

header Parameters
acting-tenant-id
string

Tenant code. Used when not passing the tenant code in the URL path parameter

tenant-id
string

Tenant code. Used when not passing the tenant code in the URL path parameter or no acting tenant

Responses

Response samples

Content type
application/json
{ }