Product documentation
AttributeSchema
Tenant-defined, typed attribute definitions that type/validate/render the user and organization metadata bags as opinionated forms, plus curated templates an admin applies to bootstrap a schema (SSO-2543).
AttributeSchema
Tenant-defined, typed attribute definitions that type/validate/render the user and organization metadata bags as opinionated forms, plus curated templates an admin applies to bootstrap a schema (SSO-2543).
Base URL: https://api.stg.thoryn.org
Operations
| Method | Path | Summary | Scopes |
|---|---|---|---|
GET | /api/v1/attribute-schema | Attribute Schema List | tenant:attribute-schema.read |
POST | /api/v1/attribute-schema | Attribute Schema Create | tenant:attribute-schema.write |
POST | /api/v1/attribute-schema/apply-template | Attribute Schema Template Apply Template | tenant:attribute-schema.write |
GET | /api/v1/attribute-schema/templates | Attribute Schema Template List Templates | tenant:attribute-schema.read |
GET | /api/v1/attribute-schema/{id} | Attribute Schema Get | tenant:attribute-schema.read |
PATCH | /api/v1/attribute-schema/{id} | Attribute Schema Update | tenant:attribute-schema.write |
DELETE | /api/v1/attribute-schema/{id} | Attribute Schema Delete | tenant:attribute-schema.write |
Operation details
GET /api/v1/attribute-schema
Attribute Schema List
- Operation ID:
attributeSchemaList - Required scopes:
tenant:attribute-schema.read
Parameters:
| Name | In | Required | Type | Description |
|---|---|---|---|---|
entityKind | query | 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/attribute-schema
Attribute Schema Create
- Operation ID:
attributeSchemaCreate - Required scopes:
tenant:attribute-schema.write
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) |
POST /api/v1/attribute-schema/apply-template
Attribute Schema Template Apply Template
- Operation ID:
attributeSchemaTemplateApplyTemplate - Required scopes:
tenant:attribute-schema.write
Request body (required): application/json → ApplyTemplateRequest
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/attribute-schema/templates
Attribute Schema Template List Templates
- Operation ID:
attributeSchemaTemplateListTemplates - Required scopes:
tenant:attribute-schema.read
Parameters:
| Name | In | Required | Type | Description |
|---|---|---|---|---|
entityKind | query | 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) |
GET /api/v1/attribute-schema/{id}
Attribute Schema Get
- Operation ID:
attributeSchemaGet - Required scopes:
tenant:attribute-schema.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) |
PATCH /api/v1/attribute-schema/{id}
Attribute Schema Update
- Operation ID:
attributeSchemaUpdate - Required scopes:
tenant:attribute-schema.write
Parameters:
| Name | In | Required | Type | Description |
|---|---|---|---|---|
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/attribute-schema/{id}
Attribute Schema Delete
- Operation ID:
attributeSchemaDelete - Required scopes:
tenant:attribute-schema.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) |