ConsentPurpose

The ConsentPurpose resource.

Base URL: https://api.stg.thoryn.org

Operations

Method	Path	Summary	Scopes
GET	/api/v1/consent-purposes	Consent Purpose List	tenant:compliance.read
POST	/api/v1/consent-purposes	Consent Purpose Create	tenant:compliance.write
GET	/api/v1/consent-purposes/{id}	Consent Purpose Get	tenant:compliance.read
PUT	/api/v1/consent-purposes/{id}	Consent Purpose Update	tenant:compliance.write
DELETE	/api/v1/consent-purposes/{id}	Consent Purpose Delete	tenant:compliance.write
POST	/api/v1/consent-purposes/{id}/new-version	Consent Purpose New Version	tenant:compliance.write
GET	/api/v1/consent-purposes/{id}/versions	Consent Purpose Versions	tenant:compliance.read

Operation details

GET /api/v1/consent-purposes

Consent Purpose List

• Operation ID: consentPurposeList
• Required scopes: tenant:compliance.read

Responses:

Status	Description	Body
200	OK	object
401	Unauthorized — bearer token missing, expired, signed by an untrusted issuer, or missing the tnt tenant claim.	Problem (problem+json)
403	Forbidden — token lacks a required tenant:* scope, or the tnt claim does not match the tenant addressed by the request path.	Problem (problem+json)

POST /api/v1/consent-purposes

Consent Purpose Create

• Operation ID: consentPurposeCreate
• Required scopes: tenant:compliance.write

Request body (required): application/json → CreateConsentPurposeRequest

Responses:

Status	Description	Body
200	OK	object
401	Unauthorized — bearer token missing, expired, signed by an untrusted issuer, or missing the tnt tenant claim.	Problem (problem+json)
403	Forbidden — token lacks a required tenant:* scope, or the tnt claim does not match the tenant addressed by the request path.	Problem (problem+json)

GET /api/v1/consent-purposes/{id}

Consent Purpose Get

• Operation ID: consentPurposeGet
• Required scopes: tenant:compliance.read

Parameters:

Name	In	Required	Type	Description
id	path	yes	string

Responses:

Status	Description	Body
200	OK	object
401	Unauthorized — bearer token missing, expired, signed by an untrusted issuer, or missing the tnt tenant claim.	Problem (problem+json)
403	Forbidden — token lacks a required tenant:* scope, or the tnt claim does not match the tenant addressed by the request path.	Problem (problem+json)

PUT /api/v1/consent-purposes/{id}

Consent Purpose Update

• Operation ID: consentPurposeUpdate
• Required scopes: tenant:compliance.write

Parameters:

Name	In	Required	Type	Description
id	path	yes	string

Request body (required): application/json → UpdateConsentPurposeRequest

Responses:

Status	Description	Body
200	OK	object
401	Unauthorized — bearer token missing, expired, signed by an untrusted issuer, or missing the tnt tenant claim.	Problem (problem+json)
403	Forbidden — token lacks a required tenant:* scope, or the tnt claim does not match the tenant addressed by the request path.	Problem (problem+json)

DELETE /api/v1/consent-purposes/{id}

Consent Purpose Delete

• Operation ID: consentPurposeDelete
• Required scopes: tenant:compliance.write

Parameters:

Name	In	Required	Type	Description
id	path	yes	string

Responses:

Status	Description	Body
200	OK	object
401	Unauthorized — bearer token missing, expired, signed by an untrusted issuer, or missing the tnt tenant claim.	Problem (problem+json)
403	Forbidden — token lacks a required tenant:* scope, or the tnt claim does not match the tenant addressed by the request path.	Problem (problem+json)

POST /api/v1/consent-purposes/{id}/new-version

Consent Purpose New Version

• Operation ID: consentPurposeNewVersion
• Required scopes: tenant:compliance.write

Parameters:

Name	In	Required	Type	Description
id	path	yes	string

Request body: application/json → NewVersionRequest

Responses:

Status	Description	Body
200	OK	object
401	Unauthorized — bearer token missing, expired, signed by an untrusted issuer, or missing the tnt tenant claim.	Problem (problem+json)
403	Forbidden — token lacks a required tenant:* scope, or the tnt claim does not match the tenant addressed by the request path.	Problem (problem+json)

GET /api/v1/consent-purposes/{id}/versions

Consent Purpose Versions

• Operation ID: consentPurposeVersions
• Required scopes: tenant:compliance.read

Parameters:

Name	In	Required	Type	Description
id	path	yes	string

Responses:

Status	Description	Body
200	OK	object
401	Unauthorized — bearer token missing, expired, signed by an untrusted issuer, or missing the tnt tenant claim.	Problem (problem+json)
403	Forbidden — token lacks a required tenant:* scope, or the tnt claim does not match the tenant addressed by the request path.	Problem (problem+json)