Product documentation
MeConsent
The MeConsent resource.
MeConsent
The MeConsent resource.
Base URL: https://api.stg.thoryn.org
Operations
| Method | Path | Summary | Scopes |
|---|---|---|---|
GET | /api/v1/me/consents | Me Consent List | bearer, no extra scope |
POST | /api/v1/me/consents | Me Consent Grant | bearer, no extra scope |
GET | /api/v1/me/consents/{consentId}/receipt | Me Consent Receipt | bearer, no extra scope |
POST | /api/v1/me/consents/{consentId}/withdraw | Me Consent Withdraw | bearer, no extra scope |
Operation details
GET /api/v1/me/consents
Me Consent List
- Operation ID:
meConsentList - Required scopes: bearer, no extra scope
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/me/consents
Me Consent Grant
- Operation ID:
meConsentGrant - Required scopes: bearer, no extra scope
Request body (required): application/json → MeGrantConsentRequest
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/me/consents/{consentId}/receipt
Me Consent Receipt
- Operation ID:
meConsentReceipt - Required scopes: bearer, no extra scope
Parameters:
| Name | In | Required | Type | Description |
|---|---|---|---|---|
consentId | 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/me/consents/{consentId}/withdraw
Me Consent Withdraw
- Operation ID:
meConsentWithdraw - Required scopes: bearer, no extra scope
Parameters:
| Name | In | Required | Type | Description |
|---|---|---|---|---|
consentId | path | yes | string |
Request body: application/json → WithdrawConsentRequest
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) |