Certificate Authority Management REST API Reference

Use the Certificate Authority Management REST API to connect your Alexa devices to WPA2 Extensible Authentication Protocol (EAP) Transport Layer Security (TLS) networks. With this API, you create a private certificate authority (CA), import a signed CA certificate, and then let Alexa Smart Properties (ASP) issue and rotate certificates that enable your endpoints to join your WPA2-EAP Enterprise Wi-Fi networks.

Before you can use the Certificate Authority Management API, visit the Alexa Smart Properties management console and request the WPA2 Enterprise Wi-Fi add-on package. For more details about getting started, see WPA2 Enterprise Wi-Fi.

API endpoint

The endpoint of the Certificate Authority Management API is https://api.amazonalexa.com.

Authentication

Each API request must have an authorization header whose value is the access token retrieved from Login with Amazon (LWA). For details, see Manage API Access.

Access to consent information is based on the permission scopes enabled for your skill and granted by the customer. Include the following permission scope when you request an access token.

Permission scope Description

alexa::enterprise:management

Allows your skill to access the WPA2 Enterprise Wi-Fi add-on.

credential_locker::wifi_management

Operations

The Certificate Authority Management API includes the following operations.

Operation HTTP Method and URI

Create certificate authority

POST /v1/enterprise/certificateAuthorities/

Delete certificate authority

DELETE /v1/enterprise/certificateAuthorities/{certificateAuthorityId}

Get certificate authority details

GET /v1/enterprise/certificateAuthorities/{certificateAuthorityId}?expand={expand}

Import certificates

POST /v1/enterprise/certificateAuthorities/{certificateAuthorityId}/importCertificate

List certificate authorities

GET /v1/enterprise/certificateAuthorities?expand={expand}&maxResults={maxResults}&nextToken={nextToken}

Update certificate authority

PUT /v1/enterprise/certificateAuthorities/{certificateAuthorityId}

Create certificate authority

Create a private certificate authority (CA) to issue certificates to ASP endpoints so that the endpoints can join WPA2-EAP Enterprise Wi-Fi networks securely.

After you create the CA, get the Certificate Signing Request (CSR) with Get certificate authority details, and then use the CSR to get a CA certificate from your RADIUS server.

Request

To create the CA, you make a POST request to the /v1/enterprise/certificateAuthorities resource.

Request path and header example

POST /v1/enterprise/certificateAuthorities HTTP/1.1
Host: api.amazonalexa.com
Accept: application/json
Authorization: Bearer {LWA Token}

Request path and header parameters

Parameter Located in Description Type Required

access token

Header

Access token for the customer.
Set to an LWA token.

String

Yes

Request body example

Copied to clipboard.

{
   "friendlyName": { 
       "type": "PLAIN",
       "value": { 
           "text": "Customer Network #1" 
       }
   },
   "rotationPeriod": {
       "value": 6,
       "interval": "MONTHS"
   }
}

Request body properties

Property Description Type Required

friendlyName

Name of the new CA.
A CA with this name must not already exist.

NameValue object

Yes

rotationPeriod

Specifies how often to rotate certificates on endpoints.
You can define a rotation period of six months or 12 months.

Object

Yes

rotationPeriod.value

Defines the rotation period.
Valid values: 6, 12.

Integer

Yes

rotationPeriod.interval

Defines the rotation interval.
Valid value: MONTHS.

String

Yes

Response

A successful response returns HTTP 201 OK, along with the ID of the new private CA. On error, the response returns the appropriate HTTP status code and includes a response body with an Error object.

Response body example

{
   "id": "amzn1.alexa.enterprise.certificateAuthority.did.1"
}

Response body properties

Property Description Type

id

Unique, encrypted ID of the new private CA.
Formatted as an Amazon Common Identifier (ACI), aamzn1.alexa.enterprise.certificateAuthority.did.{id}.

String

HTTP status codes

For error responses, see Error types.

Status Description

201 OK

Response body contains the ID of the new private CA.

400 Bad Request

Indicates that one or more properties in the request body aren't valid.

The response might include one of the following errors types and messages:

  • INVALID_FRIENDLY_NAME – The provided friendly name is invalid. The friendly name must be between 1–100 characters.
  • INVALID_ROTATION_PERIOD – The provided rotation period is invalid. The rotation period must be 6 MONTHS or 12 MONTHS.
  • NAME_ALREADY_EXISTS – User already has a certificate authority with the provided friendlyName.

401 Unauthorized

Request didn't include the authorization token, or the included token expired or isn't valid. Or, you don't have access to the resource.

403 Forbidden

Indicates that the authorization token is valid, but the requested operation isn't allowed.

404 Not Found

Requested resource not found.

429 Too Many Requests

Permitted rate limit, specified as the number of requests per unit of time, exceeded. You can retry the request by using exponential back-off.

500 Server Error

Error occurred on the server. You can retry the request by using exponential back-off.

503 Service Unavailable

Server is down for maintenance, overloaded, or otherwise unavailable to handle the incoming request.

Delete certificate authority

Delete the specified private CA that's no longer in use. Certificates that the CA issued to devices before you delete the CA remain valid until you remove the certificate authority certificate from the trust store for your RADIUS server.

Request

To delete a CA, you make a DELETE request to the /v1/enterprise/certificateAuthorities/{certificateAuthorityId} resource.

Request path and header example

Copied to clipboard.

DELETE /v1/enterprise/certificateAuthorities/{certificateAuthorityId} HTTP/1.1
Host: api.amazonalexa.com
Accept: application/json
Authorization: Bearer {LWA Token}

Request path and header parameters

Parameter Located in Description Type Required

certificateAuthorityId

Path

ID of the private CA to delete.
Formatted as an Amazon Common Identifier (ACI), aamzn1.alexa.enterprise.certificateAuthority.did.{id}..

String

Yes

access token

Header

Access token for the customer.
Set to an LWA token.

String

Yes

Request body example

The request has no body.

Request body properties

The request has no body.

Response

A successful response returns HTTP 204 No Content. On error, the response returns the appropriate HTTP status code and includes a response body with an Error object.

Response body example

The response has no body.

Response body properties

The response has no body.

HTTP status codes

Status Description

204 No Content

CA deleted successfully.

400 Bad Request

Indicates that one or more properties in the request body aren't valid.

The response might include one of the following errors types and messages:

  • CONCURRENT_MODIFICATION – A previous update to the certificate authority is still ongoing.

401 Unauthorized

Request didn't include the authorization token, or the included token expired or isn't valid. Or, you don't have access to the resource.

403 Forbidden

Indicates that the authorization token is valid, but the requested operation isn't allowed.

404 Not Found

Requested resource not found.

429 Too Many Requests

Permitted rate limit, specified as the number of requests per unit of time, exceeded. You can retry the request by using exponential back-off.

500 Server Error

Error occurred on the server. You can retry the request by using exponential back-off.

503 Service Unavailable

Server is down for maintenance, overloaded, or otherwise unavailable to handle the incoming request.

Get certificate authority details

Get the details, including the status and the Certificate Signing Request (CSR), of the specified CA. The CSR is the prerequisite for your RADIUS server to sign a certificate for the new CA.

Request

To get the details of a CA, you make a GET request to the /v1/enterprise/certificateAuthorities/{certificateAuthorityId} resource.

Request path and header example

GET /v1/enterprise/certificateAuthorities/{certificateAuthorityId}?expand={expand} HTTP/1.1
Host: api.amazonalexa.com
Accept: application/json
Authorization: Bearer {LWA Token}

Request path and header parameters

Parameter Located in Description Type Required

certificateAuthorityId

Path

ID of the private CA.
Formatted as an Amazon Common Identifier (ACI), aamzn1.alexa.enterprise.certificateAuthority.did.{id}.

String

Yes

expand

Query

Get expanded information about the certificate authority.
Valid value: all.

String

No

access token

Header

Access token for the customer.
Set to an LWA token.

String

Yes

Request body example

The request has no body.

Request body properties

The request has no body.

Response

A successful response returns HTTP 200 OK, along with certificate details for the specified CA. On error, the response returns the appropriate HTTP status code and includes a response body with an Error object.

Response body example

{
    "id": "amzn1.alexa.enterprise.certificateAuthority.did.1",
    "friendlyName": {
        "type": "PLAIN",
        "value": {
            "text": "Customer Network #1"
        }
    },
    "status": "ACTIVE",
    "createdAt": "2024-03-15T12:10:00Z",
    "updatedAt": "2024-03-15T12:10:00Z",
    "csr": "-----BEGIN CERTIFICATE REQUEST-----CERTIFICATE_REQUEST_CONTENT-----END CERTIFICATE REQUEST-----",
    "certificateMetadata": {
        "certificate": "-----BEGIN CERTIFICATE-----CERTIFICATE_CONTENT-----END CERTIFICATE-----",
        "certificateChain": "-----BEGIN CERTIFICATE-----CERTIFICATE_CHAIN_CONTENT-----END CERTIFICATE-----",
        "expiresAt": "2024-09-15T12:10:00Z",
        "activeFrom": "2024-03-15T12:10:00Z"
    },
    "rotationPeriod": {
        "value": 6,
        "interval": "MONTHS"
    }
}

Response body properties

Property Description Type

id

ID of the private CA.
Formatted as an Amazon Common Identifier (ACI), aamzn1.alexa.enterprise.certificateAuthority.did.{id}.

String

friendlyName

Name of the CA.

NameValue object

status

Current status of the CA.
For the list of possible statuses, see Certificate authority status.

String

createdAt

Creation time of the CA.
Defined in RFC 3339 format, YYYY-MM-DDThh:mm:ssZ.

String

updatedAt

Time at which the CA was last updated.
If the CA wasn't updated, this value is the same as createdAt.
Defined in RFC 3339 format, YYYY-MM-DDThh:mm:ssZ.

String

csr

(Optional) Base64 PEM-encoded CSR for the CA.
If the expand query parameter isn't included or if the CA is in a status other than PENDING_CERTIFICATE, ACTIVE, or EXPIRED, this property is absent.

String

certificateMetadata

(Optional) Details about the CA certificate.
Included when the Import certificate operation successfully imported a certificate.

Object

certificateMetadata.certificate

(Optional) CA certificate.
Included in the response when you include the expand=all query parameter in the request.

String

certificateMetadata.certificateChain

(Optional) Certificate chain imported to the CA.
Included in the response when you include the expand=all query parameter in the request.

String

certificateMetadata.expiresAt

Time after which the certificate of the CA isn't valid. Also known as expiration time of CA.
Defined in RFC 3339 format, YYYY-MM-DDThh:mm:ssZ.

String

certificateMetadata.activeFrom

Time before which the certificate of the certificate authority isn't valid.
Defined in RFC 3339 format, YYYY-MM-DDThh:mm:ssZ.

String

rotationPeriod

Specifies how often to rotate certificates on endpoints.
You can define a rotation period of 6 months or 12 months.

Object

rotationPeriod.value

Defines the rotation period.
Valid values: 6, 12.

Integer

rotationPeriod.interval

Defines the rotation interval.
Valid value: MONTHS.

String

HTTP status codes

Status Description

201 OK

Response body contains the details about the specified CA.

400 Bad Request

Indicates that one or more properties in the request body aren't valid.

The response might include one of the following errors types and messages:

  • INVALID_EXPAND – If you included the expand parameter, its value must be all.

401 Unauthorized

Request didn't include the authorization token, or the included token expired or isn't valid. Or, you don't have access to the resource.

403 Forbidden

Indicates that the authorization token is valid, but the requested operation isn't allowed.

404 Not Found

Requested resource not found.

429 Too Many Requests

Permitted rate limit, specified as the number of requests per unit of time, exceeded. You can retry the request by using exponential back-off.

500 Server Error

Error occurred on the server. You can retry the request by using exponential back-off.

503 Service Unavailable

Server is down for maintenance, overloaded, or otherwise unavailable to handle the incoming request.

Import certificate

Import the signed CA certificate into the specified CA. You must sign the CSR provided in the Get certificate authority details operation on your RADIUS server. In return, your server provides you with the certificate and certificate chain to import to your CA. After you import the certificate, Alexa marks your CA as ACTIVE. This status enables the CA to issue certificates to ASP devices.

Request

To import the CA certification, you make a POST request to the /v1/enterprise/certificateAuthorities/{certificateAuthorityId}/importCertificate resource.

Request path and header example

Copied to clipboard.

POST /v1/enterprise/certificateAuthorities/{certificateAuthorityId}/importCertificate HTTP/1.1
Host: api.amazonalexa.com
Accept: application/json
Authorization: Bearer {LWA Token}

Request path and header parameters

Parameter Located in Description Type Required

certificateAuthorityId

Path

ID of the private CA.
Formatted as an Amazon Common Identifier (ACI), aamzn1.alexa.enterprise.certificateAuthority.did.{id}.

String

Yes

access token

Header

Access token for the customer.
Set to an LWA token.

String

Yes

Request body example

Copied to clipboard.

{
    "certificate": "-----BEGIN CERTIFICATE-----\nCERTIFICATE_CONTENT\nMULTIPLE_LINES_WITH_LINE_BREAK_CHARACTERS\n-----END CERTIFICATE-----",
    "certificateChain": "-----BEGIN CERTIFICATE-----\nCERTIFICATE_CONTENT\nMULTIPLE_LINES_WITH_LINE_BREAK_CHARACTERS\n-----END CERTIFICATE-----\n-----BEGIN CERTIFICATE-----\n\nCERTIFICATE_CONTENT\nMULTIPLE_LINES_WITH_LINE_BREAK_CHARACTERS\n----END CERTIFICATE-----"
}

Request body properties

Property Description Type Required

certificate

CA certificate to import. The certificate must be signed by your RADIUS server.

String

Yes

certificateChain

All certificates in the chain to the root CA.
The chain should exclude the certificate to import.

String

Yes

Response

A successful response returns HTTP 204 No Content. On error, the response returns the appropriate HTTP status code and includes a response body with an Error object.

Response body example

The response has no body.

Response body properties

The response has no body.

HTTP status codes

Status Description

204 No Content

CA certificate imported successfully.

400 Bad Request

Indicates that one or more properties in the request body aren't valid.

The response might include one of the following errors types and messages:

  • CERTIFICATE_MISMATCH – The specified CA certificate doesn't comply with conditions specified in the certificate that signed it.
  • CONCURRENT_MODIFICATION – A previous update to the CA is ongoing.
  • INVALID_STATE – The state of the CA doesn't allow this action to occur. For more details, see Certification authority status.
  • MALFORMED_CERTIFICATE – One or more fields in the certificate are invalid.
  • REQUEST_IN_PROGRESS – Your request is already in progress. You might receive this error when you try to import the same certificate in close succession.

401 Unauthorized

Request didn't include the authorization token, or the included token expired or isn't valid. Or, you don't have access to the resource.

403 Forbidden

Indicates that the authorization token is valid, but the requested operation isn't allowed.

404 Not Found

Requested resource not found.

429 Too Many Requests

Permitted rate limit, specified as the number of requests per unit of time, exceeded. You can retry the request by using exponential back-off.

500 Server Error

Error occurred on the server. You can retry the request by using exponential back-off.

503 Service Unavailable

Server is down for maintenance, overloaded, or otherwise unavailable to handle the incoming request.

List certificate authorities

Get a list of all certificate authorities created by the caller. You can request to include details about each CA, including CA ID and status.

Request

To list the CAs, you make a GET request to the /v1/enterprise/certificateAuthorities resource.

Request path and header example

Copied to clipboard.

GET /v1/enterprise/certificateAuthorities?expand={expand}&maxResults={maxResults}&nextToken={nextToken} HTTP/1.1
Host: api.amazonalexa.com
Accept: application/json
Authorization: Bearer {LWA Token}

Request path and header parameters

Parameter Located in Description Type Required

expand

Query

Get expanded information about the certificate authority.
Valid value: all.

String

No

maxResults

Query

Maximum number of results to return in the response.
Valid values: 1–100. Default: 10.

Integer

No

nextToken

Query

Token from the previous response.
Include if iterating over a paginated response.

String

No

access token

Header

Access token for the customer.
Set to an LWA token.

String

Yes

Request body example

The request has no body.

Request body properties

The request has no body.

Response

A successful response returns HTTP 200 OK, along with a list of CAs. On error, the response returns the appropriate HTTP status code and includes a response body with an Error object.

Response body example

{
  "certificateAuthorities": [
    {
      "id": "amzn1.alexa.enterprise.certificateAuthority.did.1",
      "friendlyName": {
        "type": "PLAIN",
        "value": {
          "text": "Customer Network #1"
        }
      },
      "status": "ACTIVE",
    "createdAt": "2024-03-15T12:10:00Z",
    "updatedAt": "2024-03-15T12:10:00Z",
    "csr": "-----BEGIN CERTIFICATE REQUEST-----CERTIFICATE_REQUEST_CONTENT-----END CERTIFICATE REQUEST-----",
    "certificateMetadata": {
        "certificate": "-----BEGIN CERTIFICATE-----CERTIFICATE_CONTENT-----END CERTIFICATE-----",
        "certificateChain": "-----BEGIN CERTIFICATE-----CERTIFICATE_CHAIN_CONTENT-----END CERTIFICATE-----",
        "expiresAt": "2024-09-15T12:10:00Z",
        "activeFrom": "2024-03-15T12:10:00Z"
      },
      "rotationPeriod": {
        "value": 6,
        "interval": "MONTHS"
      }
    }
  ],
    "paginationContext": {
    "nextToken": "someToken.1"
  }
}

Response body properties

Property Description Type

certificateAuthorities

Array of certificateAuthority objects.

Array

certificateAuthorities[].id

ID of the private CA.
Formatted as an Amazon Common Identifier (ACI), aamzn1.alexa.enterprise.certificateAuthority.did.{id}.

String

certificateAuthorities[].friendlyName

Name of the CA.

NameValue object

certificateAuthorities[].status

Current status of the CA.
For the list of possible statuses, see Certificate authority status.

String

certificateAuthorities[].createdAt

Creation time of the CA.
Defined in RFC 3339 format, YYYY-MM-DDThh:mm:ssZ.

String

certificateAuthorities[].updatedAt

Time at which the CA was last updated.
If the CA wasn't updated, this value is the same as createdAt.
Defined in RFC 3339 format, YYYY-MM-DDThh:mm:ssZ.

String

certificateAuthorities[].csr

(Optional) Base64 PEM-encoded string of the CSR for the CA.
If the expand query parameter isn't included or if the CA is in a status other than PENDING_CERTIFICATE, ACTIVE, or EXPIRED, this property is absent.

String

certificateAuthorities[].certificateMetadata

(Optional) Details about the CA certificate.
Included when the Import certificate operation successfully imported a certificate.

Object

certificateAuthorities[].certificateMetadata.certificate

(Optional) CA certificate.
Included in the response when you include the expand=all query parameter in the request.

String

certificateAuthorities[].certificateMetadata.certificateChain

(Optional) Certificate chain imported to the CA.
Included in the response when you include the expand=all query parameter in the request.

String

certificateAuthorities[].certificateMetadata.expiresAt

Time after which the CA certificate isn't valid. Also known as expiration time of the CA.
Defined in RFC 3339 format, YYYY-MM-DDThh:mm:ssZ.

String

certificateAuthorities[].certificateMetadata.activeFrom

Time before which the CA certificate isn't valid.
Defined in RFC 3339 format, YYYY-MM-DDThh:mm:ssZ.

String

certificateAuthorities[].rotationPeriod

Specifies how often to rotate certificates on endpoints.
You can define a rotation period of six months or 12 months.

Object

certificateAuthorities[].rotationPeriod.value

Defines the rotation period.
Valid values: 6, 12.

Integer

certificateAuthorities[].rotationPeriod.interval

Defines the rotation interval.
Valid value: MONTHS.

String

paginationContext

(Optional) Indicates whether there are more results to return.

Object

paginationContext.nextToken

Included when the response is truncated. Use this value in a subsequent request.

String

HTTP status codes

Status Description

200 OK

Response body contains a list of CAs.

400 Bad Request

Indicates that one or more properties in the request body aren't valid.

The response might include one of the following errors types and messages:

  • INVALID_NEXT_TOKEN – There was an issue parsing nextToken.
  • INVALID_MAX_RESULTS – The value must be in the range of 1–10.
  • INVALID_EXPAND – If you included the expand parameter, its value must be all.

401 Unauthorized

Request didn't include the authorization token, or the included token expired or isn't valid. Or, you don't have access to the resource.

403 Forbidden

Indicates that the authorization token is valid, but the requested operation isn't allowed.

404 Not Found

Requested resource not found.

429 Too Many Requests

Permitted rate limit, specified as the number of requests per unit of time, exceeded. You can retry the request by using exponential back-off.

500 Server Error

Error occurred on the server. You can retry the request by using exponential back-off.

503 Service Unavailable

Server is down for maintenance, overloaded, or otherwise unavailable to handle the incoming request.

Update certificate authority

Update the specified CA. You can change the name of the CA or change the certificate rotation period.

Request

To update a CA, you make a PUT request to the /v1/enterprise/certificateAuthorities/{certificateAuthorityId} resource.

Request path and header example

Copied to clipboard.

PUT /v1/enterprise/certificateAuthorities/{certificateAuthorityId} HTTP/1.1
Host: api.amazonalexa.com
Accept: application/json
Authorization: Bearer {LWA Token}

Request path and header parameters

Parameter Located in Description Type Required

certificateAuthorityId

Path

ID of the private CA to update.
Formatted as an Amazon Common Identifier (ACI), aamzn1.alexa.enterprise.certificateAuthority.did.{id}.

String

Yes

access token

Header

Access token for the customer.
Set to an LWA token.

String

Yes

Request body example

Copied to clipboard.

{
  "friendlyName": {
    "type": "PLAIN",
    "value": {
      "text": "Customer Network #2"
    }
  },
  "rotationPeriod": {
    "value": 6,
    "interval": "MONTHS"
  }
}

Request body properties

Property Description Type Required

friendlyName

Name of the certificate authority.
A CA with this name must not already exist.
You must include one of friendlyName or rotationPeriod, or both, in the request.

NameValue object

No

rotationPeriod

Specifies how often to rotate certificates on endpoints.
You can define a rotation period of 6 months or 12 months.
You must include one or both of friendlyName or rotationPeriod in the request.

Object

No

rotationPeriod.value

Defines the rotation period.
Valid values: 6, 12.

Integer

Yes

rotationPeriod.interval

Defines the rotation interval.
Valid value: MONTHS.

String

Yes

Response

A successful response returns HTTP 204 No Content. On error, the response returns the appropriate HTTP status code and includes a response body with an Error object.

Response body example

The response has no body.

Response body properties

The response has no body.

HTTP status codes

Status Description

204 No Content

CA updated successfully.

400 Bad Request

Indicates that one or more properties in the request body aren't valid.

The response might include one of the following errors types and messages:

  • EMPTY_INPUT – Either a new friendlyName or a new rotationPeriod must be provided.
  • INVALID_FRIENDLY_NAME – The provided friendly name is invalid. The friendly name must be between 1–100 characters.
  • INVALID_ROTATION_PERIOD – The provided rotation period is invalid. The rotation period must be 6 MONTHS or 12 MONTHS.
  • NAME_ALREADY_EXISTS – User already has a certificate authority with the provided friendlyName.

401 Unauthorized

Request didn't include the authorization token, or the included token expired or isn't valid. Or, you don't have access to the resource.

403 Forbidden

Indicates that the authorization token is valid, but the requested operation isn't allowed.

404 Not Found

Requested resource not found.

429 Too Many Requests

Permitted rate limit, specified as the number of requests per unit of time, exceeded. You can retry the request by using exponential back-off.

500 Server Error

Error occurred on the server. You can retry the request by using exponential back-off.

503 Service Unavailable

Server is down for maintenance, overloaded, or otherwise unavailable to handle the incoming request.

Certificate authority status

A CA can have one of the following statuses.

Status Description Can the CA issue certificates? Can you get the CSR and install CA certificate? Are you billed for the CA?

CREATING

CA creation is in progress.

No

No

Yes

PENDING_CERTIFICATE

CA creation completed, but the CA needs a CA certificate to be operational.

No

Yes

Yes

ACTIVE

CA is active and is ready to issue certificates.

Yes

Yes

Yes

EXPIRED

CA certificate expired.

No

Yes

Yes

FAILED

CA creation failed due to an internal error. You can't recover a failed CA.
Delete the CA and create a new one.

No

No

No

Object definitions

The Certificate Authority Management API defines the following objects.

Error object

The Error object defines the error type and message included in the response when an error occurs.

The following example shows the response body with the error type and message.

{
    "type": "BAD_REQUEST",
    "message": "The request is malformed or is missing any required parameters."
}
Property Description Type

type

Type of error that occurred.
For specific error types, see the HTTP status code table for each operation.

String

message

The error message appears only for debugging/logging purposes. You must not share it with the customer. No business logic should depend on the content of the error message..

String

NameValue object

The NameValue object is a container for names of objects.

The following table defines the properties of the object.

Property Description Type

type

Format of the value field. At this time, the only supported type is plain text.
Valid values: PLAIN.

String

value

Name.

Object

value.text

Name given in plain text.
Valid length: 1–100 characters.
Valid values: UTF-8 encoding of letters, numbers, and the following special characters, with no spaces or periods: _ - = # ; : ? @ &

String

Was this page helpful?

Last updated: frontmatter-missing