Content

Attribute supports various content defined by contentType.

Attribute types

For more details about Attribute types and contentType, see Attributes.

Content properties

Each content type must extend, based on the attribute version, either BaseAttributeContentV2 or BaseAttributeContentV3 which are abstracted from AttributeContent.

The content has the following properties defined and inherited from BaseAttributeContentV2:

Property	Type	Short description	Required
`reference`	`string`	Reference that can be used for the content value. It is useful especially when the `data` contains an object, or any other more complex data structure	No
`data`	`AttributeContent`	The value of the content, depending on the `contentType` from supported `AttributeContentType`	Yes

The content has the following properties defined and inherited from BaseAttributeContentV3:

Property	Type	Short description	Required
`reference`	`string`	Reference that can be used for the content value. It is useful especially when the `data` contains an object, or any other more complex data structure	No
`data`	`AttributeContent`	The value of the content, depending on the `contentType` from supported `AttributeContentType`	Yes
`contentType`	`AttributeContentType`	The type of the content, must match the content type of attribute definition	Yes

Supported content types

Use V3 content classes

V2 content classes are deprecated. New implementations should use V3 content classes (e.g., StringAttributeContentV3 instead of StringAttributeContentV2). The V2-only content types SECRET and CREDENTIAL are replaced by RESOURCE OBJECT in V3.

Supported content types are defined in AttributeContentType. The following content types are available and supported:

`AttributeContentType`	Class V2	Class V3	Data
`STRING`	`StringAttributeContentV2`	`StringAttributeContentV3`	`string`
`INTEGER`	`IntegerAttributeContentV2`	`IntegerAttributeContentV3`	`integer`
`SECRET`	`SecretAttributeContentV2`	N/A	`SecretAttributeContentData`
`FILE`	`FileAttributeContentV2`	`FileAttributeContentV3`	`FileAttributeContentData`
`BOOLEAN`	`BooleanAttributeContentV2`	`BooleanAttributeContentV3`	`boolean`
`TEXT`	`TextAttributeContentV2`	`TextAttributeContentV3`	`string`
`CODEBLOCK`	`CodeBlockAttributeContentV2`	`CodeBlockAttributeContentV3`	`CodeBlockAttributeContentData`
`FLOAT`	`FloatAttributeContentV2`	`FloatAttributeContentV3`	`float`
`DATE`	`DateAttributeContentV2`	`DateAttributeContentV3`	`date`
`DATETIME`	`DateTimeAttributeContentV2`	`DateTimeAttributeContentV3`	`datetime`
`TIME`	`TimeAttributeContentV2`	`TimeAttributeContentV3`	`time`
`CREDENTIAL`	`CredentialAttributeContentV2`	N/A	`CredentialAttributeContentData`
`OBJECT`	`ObjectAttributeContentV2`	`ObjectAttributeContentV3`	`object`
`RESOURCE OBJECT`	N/A	`ResourceObjectContent`	`ResourceObjectContentData`

Multiple content types in one Attribute

One Attribute can define only one contentType. Multiple different content types for one Attribute is not supported.

Content type samples

The table below shows the AttributeContentType and the sample for each type and version.

AttributeContentType

Content samples

STRING

{  
  "content": [
    {
      "reference": "string",
      "data": "string"
    }
  ]
}

{  
  "content": [
    {
      "reference": "string",
      "data": "string",
      "contentType": "string"
    }
  ]
}

INTEGER

{  
  "content": [
    {
      "reference": "string",
      "data": 12345
    }
  ]
}

{  
  "content": [
    {
      "reference": "string",
      "data": 12345,
      "contentType": "integer"
    }
  ]
}

SECRET

{  
  "content": [
    {
      "reference": "string",
      "data": {
        "secret": "secret"
        }
    }
  ]
}

V2-only

SECRET is V2-only. In V3, use RESOURCE OBJECT with AttributeResource.SECRET instead.

SECRET is handled by the platform securely, and its value will never be presented to a client once defined.

FILE

{  
  "content": [
    {
      "reference": "string",
      "data": {
        "data": "base64-encoded content of the file",
        "fileName": "name of the file",
        "mimeType": "type of the file"
      }
    }
  ]
}

{  
  "content": [
    {
      "reference": "string",
      "data": {
        "data": "base64-encoded content of the file",
        "fileName": "name of the file",
        "mimeType": "type of the file"
      },
      "contentType": "file"
    }
  ]
}

FILE type can be specifically handled based on the mimeType.

BOOLEAN

{  
  "content": [
    {
      "reference": "string",
      "data": true
    }
  ]
}

{  
  "content": [
    {
      "reference": "string",
      "data": true,
      "contentType": "boolean"
    }
  ]
}

CREDENTIAL

{
  "content": [
    {
      "reference": "identification of Credential",
      "data": {
        "name": "string",
        "uuid": "UUID of the Credential",
        "kind": "kind of the Credential",
        "attributes": [
          ...list of Credential Attributes
        ]
        "enabled": true,
        "connectorUuid": "UUID of the Credential Provider Connector",
        "connectorName": "name of the Credential Provider Connector"
      }
    }
  ]
}

V2-only

CREDENTIAL is V2-only. In V3, use RESOURCE OBJECT with AttributeResource.CREDENTIAL instead.

CREDENTIAL is a special purpose type that is handled by the platform for Connectors that needs to use the credential for authentication and authorization to technology, for example, API Key, username/password, and any other Credential.

DATE

{
  "content": [
    {
      "reference": "string",
      "data": "2022-11-30"
    }
  ]
}

{
  "content": [
    {
      "reference": "string",
      "data": "2022-11-30",
      "contentType": "date"
    }
  ]
}

DATE should be in the format yyyy-MM-dd.

FLOAT

{
  "content": [
    {
      "reference": "string",
      "data": 12.4487211
    }
  ]
}

{
  "content": [
    {
      "reference": "string",
      "data": 12.4487211,
      "contentType": "float"
    }
  ]
}

OBJECT

{
  "content": [
    {
      "reference": "identification of Object",
      "data": {
        ... any JSON object
      }
    }
  ]
}

{
  "content": [
    {
      "reference": "identification of Object",
      "data": {
        ... any JSON object
      },
      "contentType": "object"
    }
  ]
}

OBJECT type provides a flexible way how to work with the custom objects within the Attributes and Callbacks.

TEXT

{
  "content": [
    {
      "reference": "string",
      "data": "long text"
    }
  ]
}

{
  "content": [
    {
      "reference": "string",
      "data": "long text",
      "contentType": "text"
    }
  ]
}

TEXT supports long string/text data to be processed.

CODEBLOCK

{
  "content": [
    {
      "reference": "string",
      "data": {
          "language": "string",
          "code": "Block of the code in Base64. Formatting of the code is specified by variable language"
        }
    }
  ]
}

{
  "content": [
    {
      "reference": "string",
      "data": {
          "language": "string",
          "code": "Block of the code in Base64. Formatting of the code is specified by variable language"
        },
      "contentType": "codeblock"
    }
  ]
}

CODEBLOCK supports scripts from various languages. For example, to store a simple addition method written in C#

public void Add(string a, string b) {
  return a + b;
}

you would send the following content

{
  "content": [
    {
      "reference": "sample",
      "data": {
          "language": "csharp",
          "code": "cHVibGljIHZvaWQgQWRkKHN0cmluZyBhLCBzdHJpbmcgYikgewogIHJldHVybiBhICsgYjsKfQ=="
        }
    }
  ]
}

{
  "content": [
    {
      "reference": "sample",
      "data": {
          "language": "csharp",
          "code": "cHVibGljIHZvaWQgQWRkKHN0cmluZyBhLCBzdHJpbmcgYikgewogIHJldHVybiBhICsgYjsKfQ=="
        },
      "contentType": "codeblock"
    }
  ]
}

TIME

{
  "content": [
    {
      "reference": "string",
      "data": "11:45:32"
    }
  ]
}

{
  "content": [
    {
      "reference": "string",
      "data": "11:45:32",
      "contentType": "time"
    }
  ]
}

TIME should be in the format HH:mm:ss.

DATETIME

{
  "content": [
    {
      "reference": "string",
      "data": "2011-12-03T10:15:30+01:00"
    }
  ]
}

{
  "content": [
    {
      "reference": "string",
      "data": "2011-12-03T10:15:30+01:00",
      "contentType": "datetime"
    }
  ]
}

DATETIME should be in the format yyyy-MM-dd'T'HH:mm:ss.SSSXXX, which is ISO-8601 extended offset date-time format.

RESOURCE OBJECT

{
  "content": [
    {
      "reference": "My Credential",
      "data": {
        "uuid": "c18e6466-e435-4fdd-97e4-02f4f2c6ceee",
        "name": "My Credential",
        "resource": "credentials"
      },
      "contentType": "resource"
    }
  ]
}

RESOURCE OBJECT is a V3-only content type used to reference platform resource objects (e.g., Credential, Certificate, Authority). It replaces the V2-only SECRET and CREDENTIAL content types. The following resources are supported:

Resource	Data
`Certificate`	`ResourceCertificateContentData`
`Credential`	`ResourceSimpleContentData`
`Authority`	`ResourceSimpleContentData`
`Entity`	`ResourceSimpleContentData`
`Location`	`ResourceSimpleContentData`
`Secret`	`ResourceSecretContentData`

An Attribute with RESOURCE OBJECT content type must also specify the resource property in its properties and define a corresponding Resource Callback.

Content model

The following diagram represents the content model inherited from the AttributeContent. Details can be found in the CZERTAINLY Interfaces repository.

Version-specific content types

Content types highlighted in red (SecretAttributeContentV2, CredentialAttributeContentV2) are V2-only. The type highlighted in green (ResourceObjectContent) is V3-only and replaces the V2 SECRET and CREDENTIAL content types. All other content types exist in both V2 and V3.

Content properties​

Supported content types​

Content type samples​

Content model​

Content properties

Supported content types

Content type samples

Content model