Skip to content

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

MethodPathSummaryScopes
GET/api/v1/attribute-schemaAttribute Schema Listtenant:attribute-schema.read
POST/api/v1/attribute-schemaAttribute Schema Createtenant:attribute-schema.write
POST/api/v1/attribute-schema/apply-templateAttribute Schema Template Apply Templatetenant:attribute-schema.write
GET/api/v1/attribute-schema/templatesAttribute Schema Template List Templatestenant:attribute-schema.read
GET/api/v1/attribute-schema/{id}Attribute Schema Gettenant:attribute-schema.read
PATCH/api/v1/attribute-schema/{id}Attribute Schema Updatetenant:attribute-schema.write
DELETE/api/v1/attribute-schema/{id}Attribute Schema Deletetenant:attribute-schema.write

Operation details

GET /api/v1/attribute-schema

Attribute Schema List

  • Operation ID: attributeSchemaList
  • Required scopes: tenant:attribute-schema.read

Parameters:

NameInRequiredTypeDescription
entityKindqueryyesstring

Responses:

StatusDescriptionBody
200OKobject
401Unauthorized — bearer token missing, expired, signed by an untrusted issuer, or missing the tnt tenant claim.Problem (problem+json)
403Forbidden — 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/jsonCreateAttributeDefinitionRequest

Responses:

StatusDescriptionBody
200OKobject
401Unauthorized — bearer token missing, expired, signed by an untrusted issuer, or missing the tnt tenant claim.Problem (problem+json)
403Forbidden — 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/jsonApplyTemplateRequest

Responses:

StatusDescriptionBody
200OKobject
401Unauthorized — bearer token missing, expired, signed by an untrusted issuer, or missing the tnt tenant claim.Problem (problem+json)
403Forbidden — 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:

NameInRequiredTypeDescription
entityKindqueryyesstring

Responses:

StatusDescriptionBody
200OKobject
401Unauthorized — bearer token missing, expired, signed by an untrusted issuer, or missing the tnt tenant claim.Problem (problem+json)
403Forbidden — 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:

NameInRequiredTypeDescription
idpathyesstring

Responses:

StatusDescriptionBody
200OKobject
401Unauthorized — bearer token missing, expired, signed by an untrusted issuer, or missing the tnt tenant claim.Problem (problem+json)
403Forbidden — 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:

NameInRequiredTypeDescription
idpathyesstring

Request body (required): application/jsonPatchAttributeDefinitionRequest

Responses:

StatusDescriptionBody
200OKobject
401Unauthorized — bearer token missing, expired, signed by an untrusted issuer, or missing the tnt tenant claim.Problem (problem+json)
403Forbidden — 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:

NameInRequiredTypeDescription
idpathyesstring

Responses:

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