Skip to content

Product documentation

OrganizationAttributeSchema

The OrganizationAttributeSchema resource.

OrganizationAttributeSchema

The OrganizationAttributeSchema resource.

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

Operations

MethodPathSummaryScopes
GET/api/v1/organizations/{orgId}/attribute-schemaOrganization Attribute Schema Listtenant:attribute-schema.read
POST/api/v1/organizations/{orgId}/attribute-schemaOrganization Attribute Schema Createtenant:attribute-schema.write
GET/api/v1/organizations/{orgId}/attribute-schema/{id}Organization Attribute Schema Gettenant:attribute-schema.read
PATCH/api/v1/organizations/{orgId}/attribute-schema/{id}Organization Attribute Schema Updatetenant:attribute-schema.write
DELETE/api/v1/organizations/{orgId}/attribute-schema/{id}Organization Attribute Schema Deletetenant: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:

NameInRequiredTypeDescription
orgIdpathyesstring

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/organizations/{orgId}/attribute-schema

Organization Attribute Schema Create

  • Operation ID: organizationAttributeSchemaCreate
  • Required scopes: tenant:attribute-schema.write

Parameters:

NameInRequiredTypeDescription
orgIdpathyesstring

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)

GET /api/v1/organizations/{orgId}/attribute-schema/{id}

Organization Attribute Schema Get

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

Parameters:

NameInRequiredTypeDescription
orgIdpathyesstring
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/organizations/{orgId}/attribute-schema/{id}

Organization Attribute Schema Update

  • Operation ID: organizationAttributeSchemaUpdate
  • Required scopes: tenant:attribute-schema.write

Parameters:

NameInRequiredTypeDescription
orgIdpathyesstring
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/organizations/{orgId}/attribute-schema/{id}

Organization Attribute Schema Delete

  • Operation ID: organizationAttributeSchemaDelete
  • Required scopes: tenant:attribute-schema.write

Parameters:

NameInRequiredTypeDescription
orgIdpathyesstring
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)