Product documentation
OrganizationAttributeSchema
The OrganizationAttributeSchema resource.
OrganizationAttributeSchema
The OrganizationAttributeSchema resource.
Base URL: https://api.stg.thoryn.org
Operations
| Method | Path | Summary | Scopes |
|---|---|---|---|
GET | /api/v1/organizations/{orgId}/attribute-schema | Organization Attribute Schema List | tenant:attribute-schema.read |
POST | /api/v1/organizations/{orgId}/attribute-schema | Organization Attribute Schema Create | tenant:attribute-schema.write |
GET | /api/v1/organizations/{orgId}/attribute-schema/{id} | Organization Attribute Schema Get | tenant:attribute-schema.read |
PATCH | /api/v1/organizations/{orgId}/attribute-schema/{id} | Organization Attribute Schema Update | tenant:attribute-schema.write |
DELETE | /api/v1/organizations/{orgId}/attribute-schema/{id} | Organization Attribute Schema Delete | tenant:attribute-schema.write |
Operation details
GET /api/v1/organizations/{orgId}/attribute-schema
Organization Attribute Schema List
- Operation ID:
organizationAttributeSchemaList - Required scopes:
tenant:attribute-schema.read
Parameters:
| Name | In | Required | Type | Description |
|---|---|---|---|---|
orgId | 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/organizations/{orgId}/attribute-schema
Organization Attribute Schema Create
- Operation ID:
organizationAttributeSchemaCreate - Required scopes:
tenant:attribute-schema.write
Parameters:
| Name | In | Required | Type | Description |
|---|---|---|---|---|
orgId | path | yes | string |
Request body (required): application/json → CreateAttributeDefinitionRequest
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/organizations/{orgId}/attribute-schema/{id}
Organization Attribute Schema Get
- Operation ID:
organizationAttributeSchemaGet - Required scopes:
tenant:attribute-schema.read
Parameters:
| Name | In | Required | Type | Description |
|---|---|---|---|---|
orgId | path | yes | string | |
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) |
PATCH /api/v1/organizations/{orgId}/attribute-schema/{id}
Organization Attribute Schema Update
- Operation ID:
organizationAttributeSchemaUpdate - Required scopes:
tenant:attribute-schema.write
Parameters:
| Name | In | Required | Type | Description |
|---|---|---|---|---|
orgId | path | yes | string | |
id | path | yes | string |
Request body (required): application/json → PatchAttributeDefinitionRequest
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/organizations/{orgId}/attribute-schema/{id}
Organization Attribute Schema Delete
- Operation ID:
organizationAttributeSchemaDelete - Required scopes:
tenant:attribute-schema.write
Parameters:
| Name | In | Required | Type | Description |
|---|---|---|---|---|
orgId | path | yes | string | |
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) |