GlobalSign Atlas Certificate Management API documentation version v2.10

HTTP status code 200

Authentication was successful

Headers

• Authorization: required(string)

  The Authorization header

  Example:

  Bearer eyJhbGciOiAiSFMyNTYiLCAidHlwIjogIkpXVCJ9.eyJ1c2VyX2lkIjogMX0.BSf1w1blYKcbxVlyOtUogUsozH2clY34xxYPd8lQIlQ

Body

Media type: application/json;charset=utf-8

Type: object

• access_token: required(string)

Example:

{
  "access_token": "eyJhbGciOiAiSFMyNTYiLCAidHlwIjogIkpXVCJ9.eyJ1c2VyX2lkIjogMX0.BSf1w1blYKcbxVlyOtUogUsozH2clY34xxYPd8lQIlQ"
}

HTTP status code 400

Request could not be parsed

Body

Media type: application/problem+json;charset=utf-8

Type: object

• description: required(string)
• id: (string)
• errors: (object)

  key value error type

  • /^.+$/: required(string)

    key is the error type, and value contains error details

Example:

{
  "description": "Bad Request"
}

HTTP status code 401

Authentication was unsuccessful

Body

Media type: application/problem+json;charset=utf-8

Type: object

• description: required(string)
• id: (string)
• errors: (object)

  key value error type

  • /^.+$/: required(string)

    key is the error type, and value contains error details

Example:

{
  "description": "Unauthorized"
}

HTTP status code 411

Request Content-Length is absent or 0

Body

Media type: application/problem+json;charset=utf-8

Type: object

• description: required(string)
• id: (string)
• errors: (object)

  key value error type

  • /^.+$/: required(string)

    key is the error type, and value contains error details

Example:

{
  "description": "Content-Length required"
}

HTTP status code 415

Request content type is not application/json;charset=utf-8

Body

Media type: application/problem+json;charset=utf-8

Type: object

• description: required(string)
• id: (string)
• errors: (object)

  key value error type

  • /^.+$/: required(string)

    key is the error type, and value contains error details

Example:

{
  "description": "Bad Content-Type"
}

HTTP status code 422

Malformed authentication request

Body

Media type: application/problem+json;charset=utf-8

Type: object

• description: required(string)
• id: (string)
• errors: (object)

  key value error type

  • /^.+$/: required(string)

    key is the error type, and value contains error details

Example:

{
  "description": "Invalid credentials"
}

HTTP status code 503

System temporarily cannot process the request

Body

Media type: application/problem+json;charset=utf-8

Type: object

• description: required(string)
• id: (string)
• errors: (object)

  key value error type

  • /^.+$/: required(string)

    key is the error type, and value contains error details

Example:

{
  "description": "Service busy, please retry later",
  "id": "0vqe8FWeDe4DQ7rU7wbzzGmPc4B"
}

HTTP status code 201

Issuance request has been accepted

Headers

• Location: required(string)

  The URL of the newly created certificate

  Example:

  {baseUri}/certificates/{certificate}

• Content-Length: required(integer - default: 0)

  This response does not contain a body

HTTP status code 400

Request could not be parsed

Body

Media type: application/problem+json;charset=utf-8

Type: object

• description: required(string)
• id: (string)
• errors: (object)

  key value error type

  • /^.+$/: required(string)

    key is the error type, and value contains error details

Example:

{
  "description": "Bad Request"
}

HTTP status code 401

Request is unauthorized

Body

Media type: application/problem+json;charset=utf-8

Type: object

• description: required(string)
• id: (string)
• errors: (object)

  key value error type

  • /^.+$/: required(string)

    key is the error type, and value contains error details

Example:

{
  "description": "Unauthorized"
}

HTTP status code 402

Quota has been reached

Body

Media type: application/problem+json;charset=utf-8

Type: object

• description: required(string)
• id: (string)
• errors: (object)

  key value error type

  • /^.+$/: required(string)

    key is the error type, and value contains error details

Example:

{
  "description": "Quota Reached"
}

HTTP status code 411

Request Content-Length is absent or 0

Body

Media type: application/problem+json;charset=utf-8

Type: object

• description: required(string)
• id: (string)
• errors: (object)

  key value error type

  • /^.+$/: required(string)

    key is the error type, and value contains error details

Example:

{
  "description": "Content-Length required"
}

HTTP status code 415

Request content type is not application/json;charset=utf-8

Body

Media type: application/problem+json;charset=utf-8

Type: object

• description: required(string)
• id: (string)
• errors: (object)

  key value error type

  • /^.+$/: required(string)

    key is the error type, and value contains error details

Example:

{
  "description": "Bad Content-Type"
}

HTTP status code 422

Invalid request

Body

Media type: application/problem+json;charset=utf-8

Type: object

• description: required(string)
• id: (string)
• errors: (object)

  key value error type

  • /^.+$/: required(string)

    key is the error type, and value contains error details

Example:

{
  "description": "Validation error message"
}

HTTP status code 429

Request rate exceeded the set limit

Body

Media type: application/problem+json;charset=utf-8

Type: object

• description: required(string)
• id: (string)
• errors: (object)

  key value error type

  • /^.+$/: required(string)

    key is the error type, and value contains error details

Example:

{
  "description": "Rate Limit Reached"
}

HTTP status code 503

System temporarily cannot process the request

Body

Media type: application/problem+json;charset=utf-8

Type: object

• description: required(string)
• id: (string)
• errors: (object)

  key value error type

  • /^.+$/: required(string)

    key is the error type, and value contains error details

Example:

{
  "description": "Service busy, please retry later",
  "id": "0vqe8FWeDe4DQ7rU7wbzzGmPc4B"
}

HTTP status code 200

Certificate is available for retrieval

Body

Media type: application/json;charset=utf-8

Type: object

• certificate: required(string - pattern: -{5}BEGIN CERTIFICATE-{5}.+-{5}END CERTIFICATE-{5})

  The PEM-encoded certificate. The PEM encoding format (defined in RFC 1421) requires a line length of 64 characters, except for the last line which can be shorter. In JSON newlines are delimited with ASCII newline symbol "\n".

• status: required(one of ISSUED, REVOKED)
• updated_at: required(integer)
• not_after: required(integer)

  UTC UNIX timestamp after which the certificate is no longer valid

  Example:

  1524573739

• revocation_information: (object)

  This is returned only if the certificate status is REVOKED.

  • reason: required(one of unspecified, keyCompromise, cACompromise, affiliationChanged, superseded, cessationOfOperation, certificateHold, removeFromCRL, privilegeWithdrawn, aACompromise)

    Reason for which the certificate was revoked.

  • time: required(integer)

    UTC UNIX timestamp from which the certificate should be considered as revoked.

Example:

{
  "certificate": "-----BEGIN CERTIFICATE-----...-----END CERTIFICATE-----",
  "status": "REVOKED",
  "updated_at": 1477958400,
  "not_after": 1493510400,
  "revocation_information": {
    "time": 1477958400,
    "reason": "keyCompromise"
  }
}

HTTP status code 202

Issuance in progress

Body

Media type: application/json;charset=utf-8

Type: object

• description: required(string)
• id: (string)
• errors: (object)

  key value error type

  • /^.+$/: required(string)

    key is the error type, and value contains error details

Example:

{
  "description": "Operation in progress"
}

HTTP status code 401

Request is unauthorized

Body

Media type: application/problem+json;charset=utf-8

Type: object

• description: required(string)
• id: (string)
• errors: (object)

  key value error type

  • /^.+$/: required(string)

    key is the error type, and value contains error details

Example:

{
  "description": "Unauthorized"
}

HTTP status code 404

Certificate not found

Body

Media type: application/problem+json;charset=utf-8

Type: object

• description: required(string)
• id: (string)
• errors: (object)

  key value error type

  • /^.+$/: required(string)

    key is the error type, and value contains error details

Example:

{
  "description": "Not found"
}

HTTP status code 422

Invalid request

Body

Media type: application/problem+json;charset=utf-8

Type: object

• description: required(string)
• id: (string)
• errors: (object)

  key value error type

  • /^.+$/: required(string)

    key is the error type, and value contains error details

Example:

{
  "description": "Validation error message"
}

HTTP status code 429

Request rate exceeded the set limit

Body

Media type: application/problem+json;charset=utf-8

Type: object

• description: required(string)
• id: (string)
• errors: (object)

  key value error type

  • /^.+$/: required(string)

    key is the error type, and value contains error details

Example:

{
  "description": "Rate Limit Reached"
}

HTTP status code 503

System temporarily cannot process the request

Body

Media type: application/problem+json;charset=utf-8

Type: object

• description: required(string)
• id: (string)
• errors: (object)

  key value error type

  • /^.+$/: required(string)

    key is the error type, and value contains error details

Example:

{
  "description": "Service busy, please retry later",
  "id": "0vqe8FWeDe4DQ7rU7wbzzGmPc4B"
}

HTTP status code 204

Certificate successfully revoked

HTTP status code 400

Request could not be parsed

Body

Media type: application/problem+json;charset=utf-8

Type: object

• description: required(string)
• id: (string)
• errors: (object)

  key value error type

  • /^.+$/: required(string)

    key is the error type, and value contains error details

Example:

{
  "description": "Bad Request"
}

HTTP status code 401

Request is unauthorized

Body

Media type: application/problem+json;charset=utf-8

Type: object

• description: required(string)
• id: (string)
• errors: (object)

  key value error type

  • /^.+$/: required(string)

    key is the error type, and value contains error details

Example:

{
  "description": "Unauthorized"
}

HTTP status code 404

Certificate not found

Body

Media type: application/problem+json;charset=utf-8

Type: object

• description: required(string)
• id: (string)
• errors: (object)

  key value error type

  • /^.+$/: required(string)

    key is the error type, and value contains error details

Example:

{
  "description": "Not found"
}

HTTP status code 409

Certificate is already revoked or pending issuance

Body

Media type: application/problem+json;charset=utf-8

Type: object

• description: required(string)
• id: (string)
• errors: (object)

  key value error type

  • /^.+$/: required(string)

    key is the error type, and value contains error details

Example:

{
  "description": "Cannot revoke a REJECTED certificate"
}

HTTP status code 422

Invalid request

Body

Media type: application/problem+json;charset=utf-8

Type: object

• description: required(string)
• id: (string)
• errors: (object)

  key value error type

  • /^.+$/: required(string)

    key is the error type, and value contains error details

Example:

{
  "description": "Validation error message"
}

HTTP status code 429

Request rate exceeded the set limit

Body

Media type: application/problem+json;charset=utf-8

Type: object

• description: required(string)
• id: (string)
• errors: (object)

  key value error type

  • /^.+$/: required(string)

    key is the error type, and value contains error details

Example:

{
  "description": "Rate Limit Reached"
}

HTTP status code 503

System temporarily cannot process the request

Body

Media type: application/problem+json;charset=utf-8

Type: object

• description: required(string)
• id: (string)
• errors: (object)

  key value error type

  • /^.+$/: required(string)

    key is the error type, and value contains error details

Example:

{
  "description": "Service busy, please retry later",
  "id": "0vqe8FWeDe4DQ7rU7wbzzGmPc4B"
}

HTTP status code 204

Certificate successfully revoked

HTTP status code 400

Request could not be parsed

Body

Media type: application/problem+json;charset=utf-8

Type: object

• description: required(string)
• id: (string)
• errors: (object)

  key value error type

  • /^.+$/: required(string)

    key is the error type, and value contains error details

Example:

{
  "description": "Bad Request"
}

HTTP status code 401

Request is unauthorized

Body

Media type: application/problem+json;charset=utf-8

Type: object

• description: required(string)
• id: (string)
• errors: (object)

  key value error type

  • /^.+$/: required(string)

    key is the error type, and value contains error details

Example:

{
  "description": "Unauthorized"
}

HTTP status code 404

Certificate not found

Body

Media type: application/problem+json;charset=utf-8

Type: object

• description: required(string)
• id: (string)
• errors: (object)

  key value error type

  • /^.+$/: required(string)

    key is the error type, and value contains error details

Example:

{
  "description": "Not found"
}

HTTP status code 409

Certificate is already revoked or pending issuance

Body

Media type: application/problem+json;charset=utf-8

Type: object

• description: required(string)
• id: (string)
• errors: (object)

  key value error type

  • /^.+$/: required(string)

    key is the error type, and value contains error details

Example:

{
  "description": "Cannot revoke a REJECTED certificate"
}

HTTP status code 411

Request Content-Length is absent or 0

Body

Media type: application/problem+json;charset=utf-8

Type: object

• description: required(string)
• id: (string)
• errors: (object)

  key value error type

  • /^.+$/: required(string)

    key is the error type, and value contains error details

Example:

{
  "description": "Content-Length required"
}

HTTP status code 412

Access to the target resource has been denied due to an unfulfilled precondition

Body

Media type: application/problem+json;charset=utf-8

Type: object

• description: required(string)
• id: (string)
• errors: (object)

  key value error type

  • /^.+$/: required(string)

    key is the error type, and value contains error details

Example:

{
  "description": "Precondition Failed"
}

HTTP status code 415

Request content type is not application/json;charset=utf-8

Body

Media type: application/problem+json;charset=utf-8

Type: object

• description: required(string)
• id: (string)
• errors: (object)

  key value error type

  • /^.+$/: required(string)

    key is the error type, and value contains error details

Example:

{
  "description": "Bad Content-Type"
}

HTTP status code 422

Invalid request

Body

Media type: application/problem+json;charset=utf-8

Type: object

• description: required(string)
• id: (string)
• errors: (object)

  key value error type

  • /^.+$/: required(string)

    key is the error type, and value contains error details

Example:

{
  "description": "Validation error message"
}

HTTP status code 429

Request rate exceeded the set limit

Body

Media type: application/problem+json;charset=utf-8

Type: object

• description: required(string)
• id: (string)
• errors: (object)

  key value error type

  • /^.+$/: required(string)

    key is the error type, and value contains error details

Example:

{
  "description": "Rate Limit Reached"
}

HTTP status code 503

System temporarily cannot process the request

Body

Media type: application/problem+json;charset=utf-8

Type: object

• description: required(string)
• id: (string)
• errors: (object)

  key value error type

  • /^.+$/: required(string)

    key is the error type, and value contains error details

Example:

{
  "description": "Service busy, please retry later",
  "id": "0vqe8FWeDe4DQ7rU7wbzzGmPc4B"
}

HTTP status code 201

Rekey request has been accepted

Headers

• Location: required(string)

  The URL of the newly created certificate

  Example:

  {baseUri}/certificates/{certificate}

• Content-Length: required(integer - default: 0)

  This response does not contain a body

HTTP status code 400

Request could not be parsed

Body

Media type: application/problem+json;charset=utf-8

Type: object

• description: required(string)
• id: (string)
• errors: (object)

  key value error type

  • /^.+$/: required(string)

    key is the error type, and value contains error details

Example:

{
  "description": "Bad Request"
}

HTTP status code 401

Request is unauthorized

Body

Media type: application/problem+json;charset=utf-8

Type: object

• description: required(string)
• id: (string)
• errors: (object)

  key value error type

  • /^.+$/: required(string)

    key is the error type, and value contains error details

Example:

{
  "description": "Unauthorized"
}

HTTP status code 404

Requested resource is not found

Body

Media type: application/problem+json;charset=utf-8

Type: object

• description: required(string)
• id: (string)
• errors: (object)

  key value error type

  • /^.+$/: required(string)

    key is the error type, and value contains error details

Example:

{
  "description": "Not found"
}

HTTP status code 411

Request Content-Length is absent or 0

Body

Media type: application/problem+json;charset=utf-8

Type: object

• description: required(string)
• id: (string)
• errors: (object)

  key value error type

  • /^.+$/: required(string)

    key is the error type, and value contains error details

Example:

{
  "description": "Content-Length required"
}

HTTP status code 415

Request content type is not application/json;charset=utf-8

Body

Media type: application/problem+json;charset=utf-8

Type: object

• description: required(string)
• id: (string)
• errors: (object)

  key value error type

  • /^.+$/: required(string)

    key is the error type, and value contains error details

Example:

{
  "description": "Bad Content-Type"
}

HTTP status code 422

Invalid request

Body

Media type: application/problem+json;charset=utf-8

Type: object

• description: required(string)
• id: (string)
• errors: (object)

  key value error type

  • /^.+$/: required(string)

    key is the error type, and value contains error details

Example:

{
  "description": "Validation error message"
}

HTTP status code 429

Request rate exceeded the set limit

Body

Media type: application/problem+json;charset=utf-8

Type: object

• description: required(string)
• id: (string)
• errors: (object)

  key value error type

  • /^.+$/: required(string)

    key is the error type, and value contains error details

Example:

{
  "description": "Rate Limit Reached"
}

HTTP status code 503

System temporarily cannot process the request

Body

Media type: application/problem+json;charset=utf-8

Type: object

• description: required(string)
• id: (string)
• errors: (object)

  key value error type

  • /^.+$/: required(string)

    key is the error type, and value contains error details

Example:

{
  "description": "Service busy, please retry later",
  "id": "0vqe8FWeDe4DQ7rU7wbzzGmPc4B"
}

HTTP status code 200

Returns the chain of trust for certificates issued by your account, starting with the issuing CA and ending with the root CA.

Body

Media type: application/json;charset=utf-8

Type: array of string

Example:

[
  "-----BEGIN CERTIFICATE-----...-----END CERTIFICATE-----",
  "-----BEGIN CERTIFICATE-----...-----END CERTIFICATE-----"
]

HTTP status code 401

Request is unauthorized

Body

Media type: application/problem+json;charset=utf-8

Type: object

• description: required(string)
• id: (string)
• errors: (object)

  key value error type

  • /^.+$/: required(string)

    key is the error type, and value contains error details

Example:

{
  "description": "Unauthorized"
}

HTTP status code 503

System temporarily cannot process the request

Body

Media type: application/problem+json;charset=utf-8

Type: object

• description: required(string)
• id: (string)
• errors: (object)

  key value error type

  • /^.+$/: required(string)

    key is the error type, and value contains error details

Example:

{
  "description": "Service busy, please retry later",
  "id": "0vqe8FWeDe4DQ7rU7wbzzGmPc4B"
}

HTTP status code 200

Returns the validation policy associated with your account

Body

Media type: application/json;charset=utf-8

Type: object

• validity: required(object)
  • secondsmin: required(integer)
  • secondsmax: required(integer)
  • not_before_negative_skew: required(integer)

    Maximum deviation of the certificate request not_before field from the current server timestamp in the past

  • not_before_positive_skew: required(integer)

    Maximum deviation of the certificate request not_before field from the current server timestamp in the future

  • issuer_expiry: required(integer)

    The Epoch timestamp indicating when the issuer configured for your service will expire. This is the maximum not_after value it is possible to have included in a certificate requested from this service.

• subject_dn: (object)

  Validation policy for subject_dn field.

  • common_name: required(object)

    Validation policy for a string field.

    • presence: required(one of REQUIRED, OPTIONAL, FORBIDDEN, STATIC, API_OVERRIDE, OPTIONAL_API_OVERRIDE)

      Determines if a field is required, optional, forbidden, static, or overwritten by the service.

      • REQUIRED presence for a field specifies that the field SHALL be included in certificate requests.
      • OPTIONAL presence for a field specifies that the field MAY be included in certificate requests.
      • STATIC presence for a field specifies that the field SHALL NOT be included in certificate requests, and instead will be provided automatically.
      • FORBIDDEN presence for a field specifies that the field SHALL NOT be included in certificate requests and SHALL NOT be supplied automatically. The field will be empty or absent from the resulting certificate.
      • API_OVERRIDE presence for a field specifies that the field SHALL NOT be included in certificate requests. The value will instead be computed dynamically.
      • OPTIONAL_API_OVERRIDE presence for a field specifies that the field MAY be included in certificate requests. If a value is not provided in the request, then instead a value will be computed dynamically. If a value is provided in the request, then the value provided will be used as is and will not be overwritten.
    • format: required(string)
  • surname: required(object)

    Validation policy for a string field.

    • presence: required(one of REQUIRED, OPTIONAL, FORBIDDEN, STATIC, API_OVERRIDE, OPTIONAL_API_OVERRIDE)
    • format: required(string)
  • given_name: required(object)

    Validation policy for a string field.

    • presence: required(one of REQUIRED, OPTIONAL, FORBIDDEN, STATIC, API_OVERRIDE, OPTIONAL_API_OVERRIDE)
    • format: required(string)
  • organization: required(object)

    Validation policy for a string field.

    • presence: required(one of REQUIRED, OPTIONAL, FORBIDDEN, STATIC, API_OVERRIDE, OPTIONAL_API_OVERRIDE)
    • format: required(string)
  • organizational_unit: required(object)

    Validation policy for list fields that are validated by regex matching.

    • static: required(boolean)
    • list: required(array of string)
    • mincount: required(integer)
    • maxcount: required(integer)
  • organization_identifier: required(object)

    Validation policy for a string field.

    • presence: required(one of REQUIRED, OPTIONAL, FORBIDDEN, STATIC, API_OVERRIDE, OPTIONAL_API_OVERRIDE)
    • format: required(string)
  • country: required(object)

    Validation policy for a string field.

    • presence: required(one of REQUIRED, OPTIONAL, FORBIDDEN, STATIC, API_OVERRIDE, OPTIONAL_API_OVERRIDE)
    • format: required(string)
  • state: required(object)

    Validation policy for a string field.

    • presence: required(one of REQUIRED, OPTIONAL, FORBIDDEN, STATIC, API_OVERRIDE, OPTIONAL_API_OVERRIDE)
    • format: required(string)
  • locality: required(object)

    Validation policy for a string field.

    • presence: required(one of REQUIRED, OPTIONAL, FORBIDDEN, STATIC, API_OVERRIDE, OPTIONAL_API_OVERRIDE)
    • format: required(string)
  • street_address: required(object)

    Validation policy for a string field.

    • presence: required(one of REQUIRED, OPTIONAL, FORBIDDEN, STATIC, API_OVERRIDE, OPTIONAL_API_OVERRIDE)
    • format: required(string)
  • postal_code: required(object)

    Validation policy for a string field.

    • presence: required(one of REQUIRED, OPTIONAL, FORBIDDEN, STATIC, API_OVERRIDE, OPTIONAL_API_OVERRIDE)
    • format: required(string)
  • email: required(object)

    Validation policy for a string field.

    • presence: required(one of REQUIRED, OPTIONAL, FORBIDDEN, STATIC, API_OVERRIDE, OPTIONAL_API_OVERRIDE)
    • format: required(string)
  • pseudonym: required(object)

    Validation policy for a string field.

    • presence: required(one of REQUIRED, OPTIONAL, FORBIDDEN, STATIC, API_OVERRIDE, OPTIONAL_API_OVERRIDE)
    • format: required(string)
  • jurisdiction_of_incorporation_locality_name: required(object)

    Validation policy for a string field.

    • presence: required(one of REQUIRED, OPTIONAL, FORBIDDEN, STATIC, API_OVERRIDE, OPTIONAL_API_OVERRIDE)
    • format: required(string)
  • jurisdiction_of_incorporation_state_or_province_name: required(object)

    Validation policy for a string field.

    • presence: required(one of REQUIRED, OPTIONAL, FORBIDDEN, STATIC, API_OVERRIDE, OPTIONAL_API_OVERRIDE)
    • format: required(string)
  • jurisdiction_of_incorporation_country_name: required(object)

    Validation policy for a string field.

    • presence: required(one of REQUIRED, OPTIONAL, FORBIDDEN, STATIC, API_OVERRIDE, OPTIONAL_API_OVERRIDE)
    • format: required(string)
  • business_category: required(object)

    Validation policy for a string field.

    • presence: required(one of REQUIRED, OPTIONAL, FORBIDDEN, STATIC, API_OVERRIDE, OPTIONAL_API_OVERRIDE)
    • format: required(string)
  • serial_number: required(object)

    Validation policy for a string field.

    • presence: required(one of REQUIRED, OPTIONAL, FORBIDDEN, STATIC, API_OVERRIDE, OPTIONAL_API_OVERRIDE)
    • format: required(string)
  • extra_attributes: required(object)
    • /^([0-9]{1,9}\.){0,63}[0-9]+$/: required(object)

      Validation policy for type_and_value fields.

      • static: required(boolean)
      • value_type: required(one of IA5STRING, PRINTABLESTRING, UTF8STRING, INTEGER, DER, NIL)

        This field describes what ASN.1 type the value in a type_and_value object should be encoded as. IA5STRING: International ASCII characters (International Alphabet 5). PRINTABLESTRING: a-z, A-Z, 0-9, ' () +,-.?:/= and SPACE. UTF8STRING: any character from a recognized alphabet (including ASCII control characters). INTEGER: values can be positive, negative, or zero, and can have any magnitude. DER: hex string of DER encoded data which will be used as-is. Should include Tag Length and Value. NIL: Indicates no value will be present.

      • value_format: (string)
      • mincount: required(integer)
      • maxcount: required(integer)

  Example:

  {
    "common_name": {
      "presence": "REQUIRED",
      "format": "^[A-Za-z][A-Za-z -]+$"
    },
    "surname": {
      "presence": "REQUIRED",
      "format": "^[A-Za-z][A-Za-z -]+$"
    },
    "given_name": {
      "presence": "REQUIRED",
      "format": "^[A-Za-z][A-Za-z -]+$"
    },
    "organization": {
      "presence": "STATIC",
      "format": "GMO GlobalSign"
    },
    "organizational_unit": {
      "static": false,
      "list": [
        "^[A-Za-z][A-Za-z \\-]+$"
      ],
      "mincount": 1,
      "maxcount": 3
    },
    "organization_identifier": {
      "presence": "OPTIONAL",
      "format": "^[A-Za-z][A-Za-z \\-]+$"
    },
    "country": {
      "presence": "STATIC",
      "format": "GB"
    },
    "state": {
      "presence": "OPTIONAL",
      "format": "^[A-Za-z][A-Za-z \\-]+$"
    },
    "locality": {
      "presence": "OPTIONAL",
      "format": "^[A-Za-z][A-Za-z \\-]+$"
    },
    "street_address": {
      "presence": "OPTIONAL",
      "format": "^\\w+$"
    },
    "postal_code": {
      "presence": "OPTIONAL",
      "format": "^[A-Za-z][A-Za-z \\-]+$"
    },
    "email": {
      "presence": "REQUIRED",
      "format": "^\\w[-._\\w]*\\w@\\w[-._\\w]*\\w.\\w{2,3}"
    },
    "pseudonym": {
      "presence": "OPTIONAL",
      "format": "^[A-Za-z][A-Za-z]+$"
    },
    "jurisdiction_of_incorporation_locality_name": {
      "presence": "OPTIONAL",
      "format": "^[A-Za-z \\-]*$"
    },
    "jurisdiction_of_incorporation_state_or_province_name": {
      "presence": "OPTIONAL",
      "format": "^[A-Za-z \\-]*$"
    },
    "jurisdiction_of_incorporation_country_name": {
      "presence": "FORBIDDEN",
      "format": "^[A-Za-z \\-]*$"
    },
    "business_category": {
      "presence": "OPTIONAL",
      "format": "^[A-Za-z \\-]*$"
    },
    "serial_number": {
      "presence": "OPTIONAL",
      "format": "^[A-Za-z \\-]*$"
    },
    "extra_attributes": {
      "1.3.6.1.5.5.7.48.1.5": {
        "static": true,
        "value_type": "PRINTABLESTRING",
        "value_format": "static attribute",
        "mincount": 1,
        "maxcount": 1
      },
      "1.3.6.1.5.5.7.48.1.6": {
        "static": false,
        "value_type": "UTF8STRING",
        "value_format": "^[A-Za-z \\\\-]*$",
        "mincount": 0,
        "maxcount": 3
      }
    }
  }

• san: (object)

  Validation policy for san field.

  • dns_names: required(object)

    Validation policy for list fields that are validated by suffix matching.

    • static: required(boolean)
    • list: required(array of string)
    • mincount: required(integer)
    • maxcount: required(integer)
  • emails: required(object)

    Validation policy for list fields that are validated by suffix matching.

    • static: required(boolean)
    • list: required(array of string)
    • mincount: required(integer)
    • maxcount: required(integer)
  • uris: required(object)

    Validation policy for list fields that are validated by regex matching.

    • static: required(boolean)
    • list: required(array of string)
    • mincount: required(integer)
    • maxcount: required(integer)
  • ip_addresses: required(object)

    Validation policy for list fields that are validated by regex matching.

    • static: required(boolean)
    • list: required(array of string)
    • mincount: required(integer)
    • maxcount: required(integer)
  • other_names: required(object)
    • /^([0-9]{1,9}\.){0,63}[0-9]+$/: required(object)

      Validation policy for type_and_value fields.

      • static: required(boolean)
      • value_type: required(one of IA5STRING, PRINTABLESTRING, UTF8STRING, INTEGER, DER, NIL)

        This field describes what ASN.1 type the value in a type_and_value object should be encoded as. IA5STRING: International ASCII characters (International Alphabet 5). PRINTABLESTRING: a-z, A-Z, 0-9, ' () +,-.?:/= and SPACE. UTF8STRING: any character from a recognized alphabet (including ASCII control characters). INTEGER: values can be positive, negative, or zero, and can have any magnitude. DER: hex string of DER encoded data which will be used as-is. Should include Tag Length and Value. NIL: Indicates no value will be present.

      • value_format: (string)
      • mincount: required(integer)
      • maxcount: required(integer)

  Example:

  {
    "dns_names": {
      "static": false,
      "list": [
        ".hvca.demo.globalsign.com"
      ],
      "mincount": 0,
      "maxcount": 1
    },
    "emails": {
      "static": false,
      "list": [
        "@hvca.demo.globalsign.com"
      ],
      "mincount": 0,
      "maxcount": 1
    },
    "ip_addresses": {
      "static": false,
      "list": [],
      "mincount": 0,
      "maxcount": 0
    },
    "uris": {
      "static": false,
      "list": [
        ".*\\.hvca\\.demo\\.globalsign\\.com/[A-Za-z /.]*$"
      ],
      "mincount": 0,
      "maxcount": 1
    },
    "other_names": {
      "1.3.6.1.5.5.7.48.1.5": {
        "static": false,
        "value_type": "UTF8STRING",
        "value_format": "^[A-Za-z.-]@demo.globalsign.com",
        "mincount": 0,
        "maxcount": 1
      }
    }
  }

• key_usages: (object)

  Validation policy for key_usages field.

  • digital_signature: required(one of OPTIONAL, STATIC_TRUE, STATIC_FALSE)

    Determines if a boolean field is optional or statically set to true or false.

  • content_commitment: required(one of OPTIONAL, STATIC_TRUE, STATIC_FALSE)

    Determines if a boolean field is optional or statically set to true or false.

  • key_encipherment: required(one of OPTIONAL, STATIC_TRUE, STATIC_FALSE)

    Determines if a boolean field is optional or statically set to true or false.

  • data_encipherment: required(one of OPTIONAL, STATIC_TRUE, STATIC_FALSE)

    Determines if a boolean field is optional or statically set to true or false.

  • key_agreement: required(one of OPTIONAL, STATIC_TRUE, STATIC_FALSE)

    Determines if a boolean field is optional or statically set to true or false.

  • key_certificate_sign: required(one of OPTIONAL, STATIC_TRUE, STATIC_FALSE)

    Determines if a boolean field is optional or statically set to true or false.

  • crl_sign: required(one of OPTIONAL, STATIC_TRUE, STATIC_FALSE)

    Determines if a boolean field is optional or statically set to true or false.

  • encipher_only: required(one of OPTIONAL, STATIC_TRUE, STATIC_FALSE)

    Determines if a boolean field is optional or statically set to true or false.

  • decipher_only: required(one of OPTIONAL, STATIC_TRUE, STATIC_FALSE)

    Determines if a boolean field is optional or statically set to true or false.

  Example:

  {
    "digital_signature": "OPTIONAL",
    "content_commitment": "OPTIONAL",
    "key_encipherment": "OPTIONAL",
    "data_encipherment": "OPTIONAL",
    "key_agreement": "OPTIONAL",
    "key_certificate_sign": "OPTIONAL",
    "crl_sign": "OPTIONAL",
    "encipher_only": "OPTIONAL",
    "decipher_only": "OPTIONAL"
  }

• extended_key_usages: (object)

  Validation policy for extended_key_usages field.

  • ekus: required(object)

    Validation policy for list fields that are validated by regex matching.

    • static: required(boolean)
    • list: required(array of string)
    • mincount: required(integer)
    • maxcount: required(integer)
  • critical: required(boolean)

  Example:

  {
    "ekus": {
      "static": false,
      "list": [
        "^1.3.6.1.5.5.7.3.[1-3]$"
      ],
      "mincount": 1,
      "maxcount": 3
    },
    "critical": true
  }

• subject_da: (object)

  Validation policy for subject_da field.

  • gender: required(object)

    Validation policy for a string field.

    • presence: required(one of REQUIRED, OPTIONAL, FORBIDDEN, STATIC, API_OVERRIDE, OPTIONAL_API_OVERRIDE)

      Determines if a field is required, optional, forbidden, static, or overwritten by the service.

      • REQUIRED presence for a field specifies that the field SHALL be included in certificate requests.
      • OPTIONAL presence for a field specifies that the field MAY be included in certificate requests.
      • STATIC presence for a field specifies that the field SHALL NOT be included in certificate requests, and instead will be provided automatically.
      • FORBIDDEN presence for a field specifies that the field SHALL NOT be included in certificate requests and SHALL NOT be supplied automatically. The field will be empty or absent from the resulting certificate.
      • API_OVERRIDE presence for a field specifies that the field SHALL NOT be included in certificate requests. The value will instead be computed dynamically.
      • OPTIONAL_API_OVERRIDE presence for a field specifies that the field MAY be included in certificate requests. If a value is not provided in the request, then instead a value will be computed dynamically. If a value is provided in the request, then the value provided will be used as is and will not be overwritten.
    • format: required(string)
  • date_of_birth: required(one of REQUIRED, OPTIONAL, FORBIDDEN, STATIC, API_OVERRIDE, OPTIONAL_API_OVERRIDE)

    Determines if a field is required, optional, forbidden, static, or overwritten by the service.

    • REQUIRED presence for a field specifies that the field SHALL be included in certificate requests.
    • OPTIONAL presence for a field specifies that the field MAY be included in certificate requests.
    • STATIC presence for a field specifies that the field SHALL NOT be included in certificate requests, and instead will be provided automatically.
    • FORBIDDEN presence for a field specifies that the field SHALL NOT be included in certificate requests and SHALL NOT be supplied automatically. The field will be empty or absent from the resulting certificate.
    • API_OVERRIDE presence for a field specifies that the field SHALL NOT be included in certificate requests. The value will instead be computed dynamically.
    • OPTIONAL_API_OVERRIDE presence for a field specifies that the field MAY be included in certificate requests. If a value is not provided in the request, then instead a value will be computed dynamically. If a value is provided in the request, then the value provided will be used as is and will not be overwritten.
  • place_of_birth: required(object)

    Validation policy for a string field.

    • presence: required(one of REQUIRED, OPTIONAL, FORBIDDEN, STATIC, API_OVERRIDE, OPTIONAL_API_OVERRIDE)

      Determines if a field is required, optional, forbidden, static, or overwritten by the service.

      • REQUIRED presence for a field specifies that the field SHALL be included in certificate requests.
      • OPTIONAL presence for a field specifies that the field MAY be included in certificate requests.
      • STATIC presence for a field specifies that the field SHALL NOT be included in certificate requests, and instead will be provided automatically.
      • FORBIDDEN presence for a field specifies that the field SHALL NOT be included in certificate requests and SHALL NOT be supplied automatically. The field will be empty or absent from the resulting certificate.
      • API_OVERRIDE presence for a field specifies that the field SHALL NOT be included in certificate requests. The value will instead be computed dynamically.
      • OPTIONAL_API_OVERRIDE presence for a field specifies that the field MAY be included in certificate requests. If a value is not provided in the request, then instead a value will be computed dynamically. If a value is provided in the request, then the value provided will be used as is and will not be overwritten.
    • format: required(string)
  • country_of_citizenship: required(object)

    Validation policy for list fields that are validated by regex matching.

    • static: required(boolean)
    • list: required(array of string)
    • mincount: required(integer)
    • maxcount: required(integer)
  • country_of_residence: required(object)

    Validation policy for list fields that are validated by regex matching.

    • static: required(boolean)
    • list: required(array of string)
    • mincount: required(integer)
    • maxcount: required(integer)
  • extra_attributes: required(object)
    • /^([0-9]{1,9}\.){0,63}[0-9]+$/: required(object)

      Validation policy for type_and_value fields.

      • static: required(boolean)
      • value_type: required(one of IA5STRING, PRINTABLESTRING, UTF8STRING, INTEGER, DER, NIL)

        This field describes what ASN.1 type the value in a type_and_value object should be encoded as. IA5STRING: International ASCII characters (International Alphabet 5). PRINTABLESTRING: a-z, A-Z, 0-9, ' () +,-.?:/= and SPACE. UTF8STRING: any character from a recognized alphabet (including ASCII control characters). INTEGER: values can be positive, negative, or zero, and can have any magnitude. DER: hex string of DER encoded data which will be used as-is. Should include Tag Length and Value. NIL: Indicates no value will be present.

      • value_format: (string)
      • mincount: required(integer)
      • maxcount: required(integer)

  Example:

  {
    "gender": {
      "presence": "OPTIONAL",
      "format": "^[MmFf]$"
    },
    "date_of_birth": "OPTIONAL",
    "place_of_birth": {
      "presence": "OPTIONAL",
      "format": "^[A-Za-z \\\\-]*$"
    },
    "country_of_citizenship": {
      "static": true,
      "list": [
        "GB",
        "US"
      ],
      "mincount": 2,
      "maxcount": 2
    },
    "country_of_residence": {
      "static": false,
      "list": [
        "GB",
        "US"
      ],
      "mincount": 0,
      "maxcount": 2
    },
    "extra_attributes": {
      "1.3.6.1.5.5.7.48.1.5": {
        "static": true,
        "value_type": "PRINTABLESTRING",
        "value_format": "static attribute",
        "mincount": 1,
        "maxcount": 1
      },
      "1.3.6.1.5.5.7.48.1.6": {
        "static": false,
        "value_type": "UTF8STRING",
        "value_format": "^[A-Za-z \\\\-]*$",
        "mincount": 1,
        "maxcount": 3
      }
    }
  }

• qualified_statements: (object)

  Validation policy for qualified_statements field.

  • semantics: required(object)
    • identifier: required(object)

      Validation policy for a string field.

      • presence: required(one of REQUIRED, OPTIONAL, FORBIDDEN, STATIC, API_OVERRIDE, OPTIONAL_API_OVERRIDE)

        Determines if a field is required, optional, forbidden, static, or overwritten by the service.

        • REQUIRED presence for a field specifies that the field SHALL be included in certificate requests.
        • OPTIONAL presence for a field specifies that the field MAY be included in certificate requests.
        • STATIC presence for a field specifies that the field SHALL NOT be included in certificate requests, and instead will be provided automatically.
        • FORBIDDEN presence for a field specifies that the field SHALL NOT be included in certificate requests and SHALL NOT be supplied automatically. The field will be empty or absent from the resulting certificate.
        • API_OVERRIDE presence for a field specifies that the field SHALL NOT be included in certificate requests. The value will instead be computed dynamically.
        • OPTIONAL_API_OVERRIDE presence for a field specifies that the field MAY be included in certificate requests. If a value is not provided in the request, then instead a value will be computed dynamically. If a value is provided in the request, then the value provided will be used as is and will not be overwritten.
      • format: required(string)
    • name_authorities: required(object)

      Validation policy for list fields that are validated by regex matching.

      • static: required(boolean)
      • list: required(array of string)
      • mincount: required(integer)
      • maxcount: required(integer)
  • etsi_qc_compliance: required(one of OPTIONAL, STATIC_TRUE, STATIC_FALSE)

    Determines if a boolean field is optional or statically set to true or false.

  • etsi_qc_sscd_compliance: required(one of OPTIONAL, STATIC_TRUE, STATIC_FALSE)

    Determines if a boolean field is optional or statically set to true or false.

  • etsi_qc_type: required(object)

    Validation policy for a string field.

    • presence: required(one of REQUIRED, OPTIONAL, FORBIDDEN, STATIC, API_OVERRIDE, OPTIONAL_API_OVERRIDE)

      Determines if a field is required, optional, forbidden, static, or overwritten by the service.

      • REQUIRED presence for a field specifies that the field SHALL be included in certificate requests.
      • OPTIONAL presence for a field specifies that the field MAY be included in certificate requests.
      • STATIC presence for a field specifies that the field SHALL NOT be included in certificate requests, and instead will be provided automatically.
      • FORBIDDEN presence for a field specifies that the field SHALL NOT be included in certificate requests and SHALL NOT be supplied automatically. The field will be empty or absent from the resulting certificate.
      • API_OVERRIDE presence for a field specifies that the field SHALL NOT be included in certificate requests. The value will instead be computed dynamically.
      • OPTIONAL_API_OVERRIDE presence for a field specifies that the field MAY be included in certificate requests. If a value is not provided in the request, then instead a value will be computed dynamically. If a value is provided in the request, then the value provided will be used as is and will not be overwritten.
    • format: required(string)
  • etsi_qc_retention_period: required(object)

    Validation policy for integer fields.

    • presence: required(one of REQUIRED, OPTIONAL, FORBIDDEN, STATIC, API_OVERRIDE, OPTIONAL_API_OVERRIDE)

      Determines if a field is required, optional, forbidden, static, or overwritten by the service.

      • REQUIRED presence for a field specifies that the field SHALL be included in certificate requests.
      • OPTIONAL presence for a field specifies that the field MAY be included in certificate requests.
      • STATIC presence for a field specifies that the field SHALL NOT be included in certificate requests, and instead will be provided automatically.
      • FORBIDDEN presence for a field specifies that the field SHALL NOT be included in certificate requests and SHALL NOT be supplied automatically. The field will be empty or absent from the resulting certificate.
      • API_OVERRIDE presence for a field specifies that the field SHALL NOT be included in certificate requests. The value will instead be computed dynamically.
      • OPTIONAL_API_OVERRIDE presence for a field specifies that the field MAY be included in certificate requests. If a value is not provided in the request, then instead a value will be computed dynamically. If a value is provided in the request, then the value provided will be used as is and will not be overwritten.
    • min: required(integer - minimum: 0)
    • max: required(integer - minimum: 0)
  • etsi_qc_pds: required(object)
    • presence: required(one of REQUIRED, OPTIONAL, FORBIDDEN, STATIC, API_OVERRIDE, OPTIONAL_API_OVERRIDE)

      Determines if a field is required, optional, forbidden, static, or overwritten by the service.

      • REQUIRED presence for a field specifies that the field SHALL be included in certificate requests.
      • OPTIONAL presence for a field specifies that the field MAY be included in certificate requests.
      • STATIC presence for a field specifies that the field SHALL NOT be included in certificate requests, and instead will be provided automatically.
      • FORBIDDEN presence for a field specifies that the field SHALL NOT be included in certificate requests and SHALL NOT be supplied automatically. The field will be empty or absent from the resulting certificate.
      • API_OVERRIDE presence for a field specifies that the field SHALL NOT be included in certificate requests. The value will instead be computed dynamically.
      • OPTIONAL_API_OVERRIDE presence for a field specifies that the field MAY be included in certificate requests. If a value is not provided in the request, then instead a value will be computed dynamically. If a value is provided in the request, then the value provided will be used as is and will not be overwritten.
    • policies: required(object)
      • /^[A-Z]{2}/: required(string)

  Example:

  {
    "semantics": {
      "identifier": {
        "presence": "STATIC",
        "format": "1.1.1.1.1.1"
      },
      "name_authorities": {
        "static": true,
        "list": [
          "contact@ra1.globalsign.com"
        ],
        "mincount": 1,
        "maxcount": 1
      }
    },
    "etsi_qc_compliance": "STATIC_TRUE",
    "etsi_qc_sscd_compliance": "OPTIONAL",
    "etsi_qc_type": {
      "presence": "REQUIRED",
      "format": "^0.4.0.1862.1.6.[1-3]$"
    },
    "etsi_qc_retention_period": {
      "presence": "OPTIONAL",
      "min": 1,
      "max": 3
    },
    "etsi_qc_pds": {
      "presence": "STATIC",
      "policies": {
        "EN": "https://etsi.pds.demo.globalsign.com/en/pds"
      }
    }
  }

• ms_extension_template: (object)

  Validation policy for ms_extension_template field.

  • critical: required(boolean)
  • template_id: required(object)

    Validation policy for a string field.

    • presence: required(one of REQUIRED, OPTIONAL, FORBIDDEN, STATIC, API_OVERRIDE, OPTIONAL_API_OVERRIDE)

      Determines if a field is required, optional, forbidden, static, or overwritten by the service.

      • REQUIRED presence for a field specifies that the field SHALL be included in certificate requests.
      • OPTIONAL presence for a field specifies that the field MAY be included in certificate requests.
      • STATIC presence for a field specifies that the field SHALL NOT be included in certificate requests, and instead will be provided automatically.
      • FORBIDDEN presence for a field specifies that the field SHALL NOT be included in certificate requests and SHALL NOT be supplied automatically. The field will be empty or absent from the resulting certificate.
      • API_OVERRIDE presence for a field specifies that the field SHALL NOT be included in certificate requests. The value will instead be computed dynamically.
      • OPTIONAL_API_OVERRIDE presence for a field specifies that the field MAY be included in certificate requests. If a value is not provided in the request, then instead a value will be computed dynamically. If a value is provided in the request, then the value provided will be used as is and will not be overwritten.
    • format: required(string)
  • major_version: required(object)

    Validation policy for integer fields.

    • presence: required(one of REQUIRED, OPTIONAL, FORBIDDEN, STATIC, API_OVERRIDE, OPTIONAL_API_OVERRIDE)

      Determines if a field is required, optional, forbidden, static, or overwritten by the service.

      • REQUIRED presence for a field specifies that the field SHALL be included in certificate requests.
      • OPTIONAL presence for a field specifies that the field MAY be included in certificate requests.
      • STATIC presence for a field specifies that the field SHALL NOT be included in certificate requests, and instead will be provided automatically.
      • FORBIDDEN presence for a field specifies that the field SHALL NOT be included in certificate requests and SHALL NOT be supplied automatically. The field will be empty or absent from the resulting certificate.
      • API_OVERRIDE presence for a field specifies that the field SHALL NOT be included in certificate requests. The value will instead be computed dynamically.
      • OPTIONAL_API_OVERRIDE presence for a field specifies that the field MAY be included in certificate requests. If a value is not provided in the request, then instead a value will be computed dynamically. If a value is provided in the request, then the value provided will be used as is and will not be overwritten.
    • min: required(integer - minimum: 0)
    • max: required(integer - minimum: 0)
  • minor_version: required(object)

    Validation policy for integer fields.

    • presence: required(one of REQUIRED, OPTIONAL, FORBIDDEN, STATIC, API_OVERRIDE, OPTIONAL_API_OVERRIDE)

      Determines if a field is required, optional, forbidden, static, or overwritten by the service.

      • REQUIRED presence for a field specifies that the field SHALL be included in certificate requests.
      • OPTIONAL presence for a field specifies that the field MAY be included in certificate requests.
      • STATIC presence for a field specifies that the field SHALL NOT be included in certificate requests, and instead will be provided automatically.
      • FORBIDDEN presence for a field specifies that the field SHALL NOT be included in certificate requests and SHALL NOT be supplied automatically. The field will be empty or absent from the resulting certificate.
      • API_OVERRIDE presence for a field specifies that the field SHALL NOT be included in certificate requests. The value will instead be computed dynamically.
      • OPTIONAL_API_OVERRIDE presence for a field specifies that the field MAY be included in certificate requests. If a value is not provided in the request, then instead a value will be computed dynamically. If a value is provided in the request, then the value provided will be used as is and will not be overwritten.
    • min: required(integer - minimum: 0)
    • max: required(integer - minimum: 0)

  Example:

  {
    "critical": true,
    "template_id": {
      "presence": "REQUIRED",
      "format": "^1.2.3.4.123.4.5.[1-3]$"
    },
    "major_version": {
      "presence": "REQUIRED",
      "min": 1,
      "max": 10
    },
    "minor_version": {
      "presence": "OPTIONAL",
      "min": 1,
      "max": 10
    }
  }

• custom_extensions: (object)

  Validation policy for custom_extensions field.

  • /^([0-9]{1,9}\.){0,63}[0-9]+$/: required(object)

    Validation policy for extension fields.

    • presence: required(one of REQUIRED, OPTIONAL, FORBIDDEN, STATIC, API_OVERRIDE, OPTIONAL_API_OVERRIDE)

      Determines if a field is required, optional, forbidden, static, or overwritten by the service.

      • REQUIRED presence for a field specifies that the field SHALL be included in certificate requests.
      • OPTIONAL presence for a field specifies that the field MAY be included in certificate requests.
      • STATIC presence for a field specifies that the field SHALL NOT be included in certificate requests, and instead will be provided automatically.
      • FORBIDDEN presence for a field specifies that the field SHALL NOT be included in certificate requests and SHALL NOT be supplied automatically. The field will be empty or absent from the resulting certificate.
      • API_OVERRIDE presence for a field specifies that the field SHALL NOT be included in certificate requests. The value will instead be computed dynamically.
      • OPTIONAL_API_OVERRIDE presence for a field specifies that the field MAY be included in certificate requests. If a value is not provided in the request, then instead a value will be computed dynamically. If a value is provided in the request, then the value provided will be used as is and will not be overwritten.
    • critical: required(boolean)
    • value_type: required(one of IA5STRING, PRINTABLESTRING, UTF8STRING, INTEGER, DER, NIL)

      This field describes what ASN.1 type the value in a type_and_value object should be encoded as. IA5STRING: International ASCII characters (International Alphabet 5). PRINTABLESTRING: a-z, A-Z, 0-9, ' () +,-.?:/= and SPACE. UTF8STRING: any character from a recognized alphabet (including ASCII control characters). INTEGER: values can be positive, negative, or zero, and can have any magnitude. DER: hex string of DER encoded data which will be used as-is. Should include Tag Length and Value. NIL: Indicates no value will be present.

    • value_format: (string)

  Example:

  {
    "1.3.6.1.5.5.7.48.1.5": {
      "presence": "STATIC",
      "critical": false,
      "value_type": "NIL"
    },
    "1.3.6.1.5.5.7.48.1.6": {
      "presence": "STATIC",
      "critical": true,
      "value_type": "DER",
      "value_format": "^([A-Fa-f0-9]{2})+$"
    }
  }

• signature: required(object)
  • algorithm: required(object)

    Validation policy for signature algrotihm fields

    • list: required(array of validators.algorithm_enum - minItems: 1)
    • presence: required(one of REQUIRED, STATIC)
  • hash_algorithm: required(object)

    Validation policy for signature hash algrotihm fields

    • list: required(array of validators.hash_algorithm_enum - minItems: 1)
    • presence: required(one of REQUIRED, STATIC)
• public_key: required(object)
  • key_type: required(one of RSA, ECDSA)
  • allowed_lengths: required(array of integer)
  • key_format: required(one of PKCS8, PKCS10)
• public_key_signature: required(one of REQUIRED, FORBIDDEN)

Example:

{
  "validity": {
    "secondsmin": 3600,
    "secondsmax": 86400,
    "not_before_negative_skew": 120,
    "not_before_positive_skew": 3600,
    "issuer_expiry": 1735732800
  },
  "subject_dn": {
    "common_name": {
      "presence": "REQUIRED",
      "format": "^[A-Za-z][A-Za-z -]+$"
    },
    "surname": {
      "presence": "REQUIRED",
      "format": "^[A-Za-z][A-Za-z -]+$"
    },
    "given_name": {
      "presence": "REQUIRED",
      "format": "^[A-Za-z][A-Za-z -]+$"
    },
    "organization": {
      "presence": "STATIC",
      "format": "GMO GlobalSign"
    },
    "organizational_unit": {
      "static": false,
      "list": [
        "^[A-Za-z][A-Za-z \\-]+$"
      ],
      "mincount": 1,
      "maxcount": 3
    },
    "organization_identifier": {
      "presence": "OPTIONAL",
      "format": "^[A-Za-z][A-Za-z \\-]+$"
    },
    "country": {
      "presence": "STATIC",
      "format": "GB"
    },
    "state": {
      "presence": "OPTIONAL",
      "format": "^[A-Za-z][A-Za-z \\-]+$"
    },
    "locality": {
      "presence": "OPTIONAL",
      "format": "^[A-Za-z][A-Za-z \\-]+$"
    },
    "street_address": {
      "presence": "OPTIONAL",
      "format": "^[A-Za-z0-9][A-Za-z0-9 \\-]+$"
    },
    "postal_code": {
      "presence": "OPTIONAL",
      "format": "^[A-Za-z][A-Za-z -]+$"
    },
    "email": {
      "presence": "FORBIDDEN",
      "format": "^\\w[-._\\w]*\\w@\\w[-._\\w]*\\w.\\w{2,3}"
    },
    "pseudonym": {
      "presence": "OPTIONAL",
      "format": "^[A-Za-z][A-Za-z]+$"
    },
    "jurisdiction_of_incorporation_locality_name": {
      "presence": "OPTIONAL",
      "format": "^[A-Za-z \\-]*$"
    },
    "jurisdiction_of_incorporation_state_or_province_name": {
      "presence": "OPTIONAL",
      "format": "^[A-Za-z \\-]*$"
    },
    "jurisdiction_of_incorporation_country_name": {
      "presence": "FORBIDDEN",
      "format": "^[A-Za-z \\-]*$"
    },
    "business_category": {
      "presence": "FORBIDDEN",
      "format": "^[A-Za-z \\-]*$"
    },
    "serial_number": {
      "presence": "OPTIONAL",
      "format": "^[A-Za-z \\-]*$"
    },
    "extra_attributes": {
      "1.3.6.1.5.5.7.48.1.5": {
        "static": true,
        "value_type": "PRINTABLESTRING",
        "value_format": "static attribute",
        "mincount": 1,
        "maxcount": 1
      },
      "1.3.6.1.5.5.7.48.1.6": {
        "static": false,
        "value_type": "UTF8STRING",
        "value_format": "^[A-Za-z \\\\-]*$",
        "mincount": 0,
        "maxcount": 3
      }
    }
  },
  "san": {
    "dns_names": {
      "static": false,
      "list": [],
      "mincount": 0,
      "maxcount": 0
    },
    "emails": {
      "static": false,
      "list": [
        "^\\w[-._\\w]*\\w@\\w[-._\\w]*\\w.\\w{2,3}$"
      ],
      "mincount": 0,
      "maxcount": 1
    },
    "ip_addresses": {
      "static": false,
      "list": [],
      "mincount": 0,
      "maxcount": 0
    },
    "uris": {
      "static": false,
      "list": [],
      "mincount": 0,
      "maxcount": 0
    },
    "other_names": {
      "1.3.6.1.5.5.7.48.1.5": {
        "static": false,
        "value_type": "UTF8STRING",
        "value_format": "^[A-Za-z.-]@demo.globalsign.com",
        "mincount": 0,
        "maxcount": 1
      }
    }
  },
  "subject_da": {
    "gender": {
      "presence": "OPTIONAL",
      "format": "^[MmFf]$"
    },
    "date_of_birth": "OPTIONAL",
    "place_of_birth": {
      "presence": "OPTIONAL",
      "format": "^[A-Za-z \\\\-]*$"
    },
    "country_of_citizenship": {
      "static": true,
      "list": [
        "GB",
        "US"
      ],
      "mincount": 2,
      "maxcount": 2
    },
    "country_of_residence": {
      "static": false,
      "list": [
        "GB",
        "US"
      ],
      "mincount": 0,
      "maxcount": 2
    },
    "extra_attributes": {
      "1.3.6.1.5.5.7.48.1.5": {
        "static": true,
        "value_type": "PRINTABLESTRING",
        "value_format": "static attribute",
        "mincount": 1,
        "maxcount": 1
      },
      "1.3.6.1.5.5.7.48.1.6": {
        "static": false,
        "value_type": "UTF8STRING",
        "value_format": "^[A-Za-z \\\\-]*$",
        "mincount": 1,
        "maxcount": 3
      }
    }
  },
  "signature": {
    "algorithm": {
      "presence": "STATIC",
      "list": [
        "RSA-PSS"
      ]
    },
    "hash_algorithm": {
      "presence": "REQUIRED",
      "list": [
        "SHA-256",
        "SHA-512"
      ]
    }
  },
  "public_key": {
    "key_type": "RSA",
    "allowed_lengths": [
      2048,
      4096
    ],
    "key_format": "PKCS8"
  },
  "public_key_signature": "REQUIRED"
}

HTTP status code 401

Request is unauthorized

Body

Media type: application/problem+json;charset=utf-8

Type: object

• description: required(string)
• id: (string)
• errors: (object)

  key value error type

  • /^.+$/: required(string)

    key is the error type, and value contains error details

Example:

{
  "description": "Unauthorized"
}

HTTP status code 503

System temporarily cannot process the request

Body

Media type: application/problem+json;charset=utf-8

Type: object

• description: required(string)
• id: (string)
• errors: (object)

  key value error type

  • /^.+$/: required(string)

    key is the error type, and value contains error details

Example:

{
  "description": "Service busy, please retry later",
  "id": "0vqe8FWeDe4DQ7rU7wbzzGmPc4B"
}

HTTP status code 200

Return integer value

Body

Media type: application/json;charset=utf-8

Type: object

• value: required(integer)

Example:

{
  "value": 12
}

HTTP status code 401

Request is unauthorized

Body

Media type: application/problem+json;charset=utf-8

Type: object

• description: required(string)
• id: (string)
• errors: (object)

  key value error type

  • /^.+$/: required(string)

    key is the error type, and value contains error details

Example:

{
  "description": "Unauthorized"
}

HTTP status code 404

Requested resource is not found

Body

Media type: application/problem+json;charset=utf-8

Type: object

• description: required(string)
• id: (string)
• errors: (object)

  key value error type

  • /^.+$/: required(string)

    key is the error type, and value contains error details

Example:

{
  "description": "Not found"
}

HTTP status code 503

System temporarily cannot process the request

Body

Media type: application/problem+json;charset=utf-8

Type: object

• description: required(string)
• id: (string)
• errors: (object)

  key value error type

  • /^.+$/: required(string)

    key is the error type, and value contains error details

Example:

{
  "description": "Service busy, please retry later",
  "id": "0vqe8FWeDe4DQ7rU7wbzzGmPc4B"
}

HTTP status code 200

Return integer value

Body

Media type: application/json;charset=utf-8

Type: object

• value: required(integer)

Example:

{
  "value": 12
}

HTTP status code 401

Request is unauthorized

Body

Media type: application/problem+json;charset=utf-8

Type: object

• description: required(string)
• id: (string)
• errors: (object)

  key value error type

  • /^.+$/: required(string)

    key is the error type, and value contains error details

Example:

{
  "description": "Unauthorized"
}

HTTP status code 404

Requested resource is not found

Body

Media type: application/problem+json;charset=utf-8

Type: object

• description: required(string)
• id: (string)
• errors: (object)

  key value error type

  • /^.+$/: required(string)

    key is the error type, and value contains error details

Example:

{
  "description": "Not found"
}

HTTP status code 503

System temporarily cannot process the request

Body

Media type: application/problem+json;charset=utf-8

Type: object

• description: required(string)
• id: (string)
• errors: (object)

  key value error type

  • /^.+$/: required(string)

    key is the error type, and value contains error details

Example:

{
  "description": "Service busy, please retry later",
  "id": "0vqe8FWeDe4DQ7rU7wbzzGmPc4B"
}

HTTP status code 200

Returns the certificate metadata

Headers

• Links: required(string)

  Links to previous/next/last page if available

  Example:

  </stats/{status}?page=2>; rel="previous"; </stats/{status}?page=4>; rel="next", </stats/{status}?page=5>; rel="last"

• Total-Count: required(integer)

  Total number of elements found

  Example:

  20

Body

Media type: application/json;charset=utf-8

Type: array of object

Items: certificate_metadata

Example:

[
  {
    "not_after": 1507906704,
    "not_before": 1507820244,
    "serial_number": "3436670571841985917699178058350683260"
  },
  {
    "not_after": 1507906704,
    "not_before": 1507820244,
    "serial_number": "4452086980628212788705863397373867915"
  }
]

HTTP status code 401

Request is unauthorized

Body

Media type: application/problem+json;charset=utf-8

Type: object

• description: required(string)
• id: (string)
• errors: (object)

  key value error type

  • /^.+$/: required(string)

    key is the error type, and value contains error details

Example:

{
  "description": "Unauthorized"
}

HTTP status code 422

Invalid request

Body

Media type: application/problem+json;charset=utf-8

Type: object

• description: required(string)
• id: (string)
• errors: (object)

  key value error type

  • /^.+$/: required(string)

    key is the error type, and value contains error details

Example:

{
  "description": "Validation error message"
}

HTTP status code 503

System temporarily cannot process the request

Body

Media type: application/problem+json;charset=utf-8

Type: object

• description: required(string)
• id: (string)
• errors: (object)

  key value error type

  • /^.+$/: required(string)

    key is the error type, and value contains error details

Example:

{
  "description": "Service busy, please retry later",
  "id": "0vqe8FWeDe4DQ7rU7wbzzGmPc4B"
}

HTTP status code 200

Returns the certificate metadata

Headers

• Links: required(string)

  Links to previous/next/last page if available

  Example:

  </stats/{status}?page=2>; rel="previous"; </stats/{status}?page=4>; rel="next", </stats/{status}?page=5>; rel="last"

• Total-Count: required(integer)

  Total number of elements found

  Example:

  20

Body

Media type: application/json;charset=utf-8

Type: array of object

Items: certificate_metadata

Example:

[
  {
    "not_after": 1507906704,
    "not_before": 1507820244,
    "serial_number": "3436670571841985917699178058350683260"
  },
  {
    "not_after": 1507906704,
    "not_before": 1507820244,
    "serial_number": "4452086980628212788705863397373867915"
  }
]

HTTP status code 401

Request is unauthorized

Body

Media type: application/problem+json;charset=utf-8

Type: object

• description: required(string)
• id: (string)
• errors: (object)

  key value error type

  • /^.+$/: required(string)

    key is the error type, and value contains error details

Example:

{
  "description": "Unauthorized"
}

HTTP status code 422

Invalid request

Body

Media type: application/problem+json;charset=utf-8

Type: object

• description: required(string)
• id: (string)
• errors: (object)

  key value error type

  • /^.+$/: required(string)

    key is the error type, and value contains error details

Example:

{
  "description": "Validation error message"
}

HTTP status code 503

System temporarily cannot process the request

Body

Media type: application/problem+json;charset=utf-8

Type: object

• description: required(string)
• id: (string)
• errors: (object)

  key value error type

  • /^.+$/: required(string)

    key is the error type, and value contains error details

Example:

{
  "description": "Service busy, please retry later",
  "id": "0vqe8FWeDe4DQ7rU7wbzzGmPc4B"
}

HTTP status code 200

Returns the certificate metadata

Headers

• Links: required(string)

  Links to previous/next/last page if available

  Example:

  </stats/{status}?page=2>; rel="previous"; </stats/{status}?page=4>; rel="next", </stats/{status}?page=5>; rel="last"

• Total-Count: required(integer)

  Total number of elements found

  Example:

  20

Body

Media type: application/json;charset=utf-8

Type: array of object

Items: certificate_metadata

Example:

[
  {
    "not_after": 1507906704,
    "not_before": 1507820244,
    "serial_number": "3436670571841985917699178058350683260"
  },
  {
    "not_after": 1507906704,
    "not_before": 1507820244,
    "serial_number": "4452086980628212788705863397373867915"
  }
]

HTTP status code 401

Request is unauthorized

Body

Media type: application/problem+json;charset=utf-8

Type: object

• description: required(string)
• id: (string)
• errors: (object)

  key value error type

  • /^.+$/: required(string)

    key is the error type, and value contains error details

Example:

{
  "description": "Unauthorized"
}

HTTP status code 422

Invalid request

Body

Media type: application/problem+json;charset=utf-8

Type: object

• description: required(string)
• id: (string)
• errors: (object)

  key value error type

  • /^.+$/: required(string)

    key is the error type, and value contains error details

Example:

{
  "description": "Validation error message"
}

HTTP status code 503

System temporarily cannot process the request

Body

Media type: application/problem+json;charset=utf-8

Type: object

• description: required(string)
• id: (string)
• errors: (object)

  key value error type

  • /^.+$/: required(string)

    key is the error type, and value contains error details

Example:

{
  "description": "Service busy, please retry later",
  "id": "0vqe8FWeDe4DQ7rU7wbzzGmPc4B"
}

HTTP status code 200

Return integer value

Body

Media type: application/json;charset=utf-8

Type: object

• value: required(integer)

Example:

{
  "value": 12
}

HTTP status code 401

Request is unauthorized

Body

Media type: application/problem+json;charset=utf-8

Type: object

• description: required(string)
• id: (string)
• errors: (object)

  key value error type

  • /^.+$/: required(string)

    key is the error type, and value contains error details

Example:

{
  "description": "Unauthorized"
}

HTTP status code 503

System temporarily cannot process the request

Body

Media type: application/problem+json;charset=utf-8

Type: object

• description: required(string)
• id: (string)
• errors: (object)

  key value error type

  • /^.+$/: required(string)

    key is the error type, and value contains error details

Example:

{
  "description": "Service busy, please retry later",
  "id": "0vqe8FWeDe4DQ7rU7wbzzGmPc4B"
}

HTTP status code 200

Returns the total number and list of all past domain claims

Headers

• Links: required(string)

  Links to previous/next/last page if available

  Example:

  </claims/domains?page=2>; rel="previous"; </claims/domains?page=4>; rel="next", </claims/domains?page=5>; rel="last"

• Total-Count: required(integer)

  Total number of elements found

  Example:

  20

Body

Media type: application/json;charset=utf-8

Type: array of basic.domain_claim

Items: domain_claim_unprefixed_token

Example:

[
  {
    "id": "A477A8393D17A55ECB2BA6A61F58FEB8",
    "status": "PENDING",
    "token": "DF259CFE1E5B4F148E603C361DC6FE59",
    "domain": "test.example.com.",
    "created_at": 1557322403,
    "assert_by": 1628429603,
    "log": [
      {
        "status": "ERROR",
        "description": "error verifying domain claim",
        "timestamp": 1577958400
      }
    ]
  },
  {
    "id": "B477A8393D17A55ECB2BA6A61F58FEB8",
    "status": "VERIFIED",
    "token": "762D90D2F4DE4B9D91858F4C58F7870B",
    "domain": "test2.example.com.",
    "created_at": 1524543199,
    "expires_at": 1628429603,
    "last_verified_at": 1537958400,
    "last_verifcation_method": "DNS",
    "log": [
      {
        "status": "SUCCESS",
        "description": "claim successfully verified",
        "timestamp": 1537958400
      }
    ]
  }
]

HTTP status code 401

Request is unauthorized

Body

Media type: application/problem+json;charset=utf-8

Type: object

• description: required(string)
• id: (string)
• errors: (object)

  key value error type

  • /^.+$/: required(string)

    key is the error type, and value contains error details

Example:

{
  "description": "Unauthorized"
}

HTTP status code 422

Invalid request

Body

Media type: application/problem+json;charset=utf-8

Type: object

• description: required(string)
• id: (string)
• errors: (object)

  key value error type

  • /^.+$/: required(string)

    key is the error type, and value contains error details

Example:

{
  "description": "Validation error message"
}

HTTP status code 503

System temporarily cannot process the request

Body

Media type: application/problem+json;charset=utf-8

Type: object

• description: required(string)
• id: (string)
• errors: (object)

  key value error type

  • /^.+$/: required(string)

    key is the error type, and value contains error details

Example:

{
  "description": "Service busy, please retry later",
  "id": "0vqe8FWeDe4DQ7rU7wbzzGmPc4B"
}

HTTP status code 201

Returned after accepting the domain claim

Headers

• Location: required(string)

  The URL of the newly created domain claim

  Example:

  /claims/domains/{claimID}

Body

Media type: application/json;charset=utf-8

Type: object

• token: required(string)

  The token value received is composed of the globalsign prefix followed by the random value generated

  Example:

  globalsign-domain-verification=A477A8393D17A55ECB2BA6A61F58FEB8

• assert_by: required(integer)

Example:

{
  "token": "globalsign-domain-verification=A477A8393D17A55ECB2BA6A61F58FEB8",
  "assert_by": 1524570139
}

HTTP status code 401

Request is unauthorized

Body

Media type: application/problem+json;charset=utf-8

Type: object

• description: required(string)
• id: (string)
• errors: (object)

  key value error type

  • /^.+$/: required(string)

    key is the error type, and value contains error details

Example:

{
  "description": "Unauthorized"
}

HTTP status code 409

A domain claim already exists for this domain

Body

Media type: application/problem+json;charset=utf-8

Type: object

• description: required(string)
• id: (string)
• errors: (object)

  key value error type

  • /^.+$/: required(string)

    key is the error type, and value contains error details

Example:

{
  "description": "Claim for domain already exists"
}

HTTP status code 422

Invalid request

Body

Media type: application/problem+json;charset=utf-8

Type: object

• description: required(string)
• id: (string)
• errors: (object)

  key value error type

  • /^.+$/: required(string)

    key is the error type, and value contains error details

Example:

{
  "description": "Validation error message",
  "errors": {
    "gsb": "example.com flagged on Google SafeBrowsing list",
    "blacklist": "example.com is not allowed by the blacklist"
  }
}

HTTP status code 503

System temporarily cannot process the request

Body

Media type: application/problem+json;charset=utf-8

Type: object

• description: required(string)
• id: (string)
• errors: (object)

  key value error type

  • /^.+$/: required(string)

    key is the error type, and value contains error details

Example:

{
  "description": "Service busy, please retry later",
  "id": "0vqe8FWeDe4DQ7rU7wbzzGmPc4B"
}

HTTP status code 200

Returns requested domain claim

Body

Media type: application/json;charset=utf-8

Type: object

• token: required(string)

  The token value received is a randomly generated value

  Example:

  A477A8393D17A55ECB2BA6A61F58FEB8

• id: required(string - minLength: 32 - maxLength: 32 - pattern: ^[A-Fa-f0-9]{32}$)

  ID of a claim

• status: required(one of PENDING, VERIFIED)

  Status of the claim

• domain: required(string)
• created_at: required(integer)

  UTC UNIX timestamp marking the time at which the domain claim was created

• expires_at: (integer)

  UTC UNIX timestamp marking the time at which the OV domain claim expires

• assert_by: (integer)

  UTC UNIX timestamp marking the time by which this claim has to be asserted. Passed this deadline a client will need to reassert the claim to get a fresh token.

• last_verified_at: (integer)

  UTC UNIX timestamp marking the time at which the domain claim was last verified or 0 if it has not yet been verified

• last_verification_method: (string)

  Indicates the way in which the claim was most recently verified

  • "NotSet" indicates the claim is either new or has been reasserted and not yet verified.
  • "DNS" indicates the verification method used is DNS.
  • "HTTP" indicates the verification method used is HTTP.
  • "HTTP_ACME" indicates the verification method used is HTTP and it is an ACME verification request.
  • "EmailConstructed" indicates the verification method used is a constructed email.
  • "EmailSOA" indicates the verification method used is an email from a DNS SOA record.
  • "EmailTXT" indicates the verification method used is an email from a DNS TXT record.
  • "EmailCAA" indicates the verification method used is an email from a DNS CAA record.
• log: required(array of basic.log_entry)

  List of verification log entries for the domain claim

  Items: log_entry

  • status: required(one of INFO, SUCCESS, ERROR)
  • description: required(string)
  • timestamp: required(integer)

Example:

{
  "id": "A477A8393D17A55ECB2BA6A61F58FEB8",
  "status": "PENDING",
  "token": "A477A8393D17A55ECB2BA6A61F58FEB8",
  "domain": "test.example.com.",
  "created_at": 1557322403,
  "assert_by": 1628429603,
  "log": [
    {
      "status": "ERROR",
      "description": "error verifying domain claim",
      "timestamp": 1577958400
    }
  ]
}

HTTP status code 401

Request is unauthorized

Body

Media type: application/problem+json;charset=utf-8

Type: object

• description: required(string)
• id: (string)
• errors: (object)

  key value error type

  • /^.+$/: required(string)

    key is the error type, and value contains error details

Example:

{
  "description": "Unauthorized"
}

HTTP status code 404

Domain claim cannot be found

Body

Media type: application/problem+json;charset=utf-8

Type: object

• description: required(string)
• id: (string)
• errors: (object)

  key value error type

  • /^.+$/: required(string)

    key is the error type, and value contains error details

Example:

{
  "description": "Not found"
}

HTTP status code 422

Invalid request

Body

Media type: application/problem+json;charset=utf-8

Type: object

• description: required(string)
• id: (string)
• errors: (object)

  key value error type

  • /^.+$/: required(string)

    key is the error type, and value contains error details

Example:

{
  "description": "Validation error message"
}

HTTP status code 503

System temporarily cannot process the request

Body

Media type: application/problem+json;charset=utf-8

Type: object

• description: required(string)
• id: (string)
• errors: (object)

  key value error type

  • /^.+$/: required(string)

    key is the error type, and value contains error details

Example:

{
  "description": "Service busy, please retry later",
  "id": "0vqe8FWeDe4DQ7rU7wbzzGmPc4B"
}

HTTP status code 202

A previous claim verification check is in progress

Body

Media type: application/json;charset=utf-8

Type: object

• description: required(string)
• id: (string)
• errors: (object)

  key value error type

  • /^.+$/: required(string)

    key is the error type, and value contains error details

Example:

{
  "description": "Operation in progress"
}

HTTP status code 204

Claim successfully deleted

HTTP status code 401

Request is unauthorized

Body

Media type: application/problem+json;charset=utf-8

Type: object

• description: required(string)
• id: (string)
• errors: (object)

  key value error type

  • /^.+$/: required(string)

    key is the error type, and value contains error details

Example:

{
  "description": "Unauthorized"
}

HTTP status code 404

A domain claim for this domain cannot be found

Body

Media type: application/problem+json;charset=utf-8

Type: object

• description: required(string)
• id: (string)
• errors: (object)

  key value error type

  • /^.+$/: required(string)

    key is the error type, and value contains error details

Example:

{
  "description": "Not found"
}

HTTP status code 422

Invalid request

Body

Media type: application/problem+json;charset=utf-8

Type: object

• description: required(string)
• id: (string)
• errors: (object)

  key value error type

  • /^.+$/: required(string)

    key is the error type, and value contains error details

Example:

{
  "description": "Validation error message"
}

HTTP status code 503

System temporarily cannot process the request

Body

Media type: application/problem+json;charset=utf-8

Type: object

• description: required(string)
• id: (string)
• errors: (object)

  key value error type

  • /^.+$/: required(string)

    key is the error type, and value contains error details

Example:

{
  "description": "Service busy, please retry later",
  "id": "0vqe8FWeDe4DQ7rU7wbzzGmPc4B"
}

HTTP status code 200

Returns the list of Authorization Domain Names (ADNs)

Body

Media type: application/json;charset=utf-8

Type: array of string

Example:

For the given domain "subdomain.domain.test.com." the Authorization Domain Names are

["test.com", "domain.test.com", "subdomain.domain.test.com"]

HTTP status code 401

Request is unauthorized

Body

Media type: application/problem+json;charset=utf-8

Type: object

• description: required(string)
• id: (string)
• errors: (object)

  key value error type

  • /^.+$/: required(string)

    key is the error type, and value contains error details

Example:

{
  "description": "Unauthorized"
}

HTTP status code 404

Requested resource is not found

Body

Media type: application/problem+json;charset=utf-8

Type: object

• description: required(string)
• id: (string)
• errors: (object)

  key value error type

  • /^.+$/: required(string)

    key is the error type, and value contains error details

Example:

{
  "description": "Not found"
}

HTTP status code 422

Invalid request

Body

Media type: application/problem+json;charset=utf-8

Type: object

• description: required(string)
• id: (string)
• errors: (object)

  key value error type

  • /^.+$/: required(string)

    key is the error type, and value contains error details

Example:

{
  "description": "Validation error message"
}

HTTP status code 503

System temporarily cannot process the request

Body

Media type: application/problem+json;charset=utf-8

Type: object

• description: required(string)
• id: (string)
• errors: (object)

  key value error type

  • /^.+$/: required(string)

    key is the error type, and value contains error details

Example:

{
  "description": "Service busy, please retry later",
  "id": "0vqe8FWeDe4DQ7rU7wbzzGmPc4B"
}

HTTP status code 201

DNS domain control assertion request for the domain was created

Headers

• Content-Length: required(integer - default: 0)

  This response does not return a body

HTTP status code 202

A previous domain control assertion request is pending

Body

Media type: application/json;charset=utf-8

Type: object

• description: required(string)
• id: (string)
• errors: (object)

  key value error type

  • /^.+$/: required(string)

    key is the error type, and value contains error details

Example:

{
  "description": "Operation in progress"
}

HTTP status code 204

Domain control assertion request verified

HTTP status code 401

Request is unauthorized

Body

Media type: application/problem+json;charset=utf-8

Type: object

• description: required(string)
• id: (string)
• errors: (object)

  key value error type

  • /^.+$/: required(string)

    key is the error type, and value contains error details

Example:

{
  "description": "Unauthorized"
}

HTTP status code 422

Invalid request

Body

Media type: application/problem+json;charset=utf-8

Type: object

• description: required(string)
• id: (string)
• errors: (object)

  key value error type

  • /^.+$/: required(string)

    key is the error type, and value contains error details

Example:

{
  "description": "Validation error message"
}

HTTP status code 424

Claim has expired and needs to be reasserted before scheduling domain control assertion

Body

Media type: application/problem+json;charset=utf-8

Type: object

• description: required(string)
• id: (string)
• errors: (object)

  key value error type

  • /^.+$/: required(string)

    key is the error type, and value contains error details

Example:

{
  "description": "Claim expired. Reassert first"
}

HTTP status code 503

System temporarily cannot process the request

Body

Media type: application/problem+json;charset=utf-8

Type: object

• description: required(string)
• id: (string)
• errors: (object)

  key value error type

  • /^.+$/: required(string)

    key is the error type, and value contains error details

Example:

{
  "description": "Service busy, please retry later",
  "id": "0vqe8FWeDe4DQ7rU7wbzzGmPc4B"
}

HTTP status code 201

HTTP domain control assertion request for the domain was created

Headers

• Content-Length: required(integer - default: 0)

  This response does not return a body

HTTP status code 202

A previous domain control assertion request is pending

Body

Media type: application/json;charset=utf-8

Type: object

• description: required(string)
• id: (string)
• errors: (object)

  key value error type

  • /^.+$/: required(string)

    key is the error type, and value contains error details

Example:

{
  "description": "Operation in progress"
}

HTTP status code 204

Domain control assertion request verified

HTTP status code 401

Request is unauthorized

Body

Media type: application/problem+json;charset=utf-8

Type: object

• description: required(string)
• id: (string)
• errors: (object)

  key value error type

  • /^.+$/: required(string)

    key is the error type, and value contains error details

Example:

{
  "description": "Unauthorized"
}

HTTP status code 411

Request Content-Length is absent or 0

Body

Media type: application/problem+json;charset=utf-8

Type: object

• description: required(string)
• id: (string)
• errors: (object)

  key value error type

  • /^.+$/: required(string)

    key is the error type, and value contains error details

Example:

{
  "description": "Content-Length required"
}

HTTP status code 415

Request content type is not application/json;charset=utf-8

Body

Media type: application/problem+json;charset=utf-8

Type: object

• description: required(string)
• id: (string)
• errors: (object)

  key value error type

  • /^.+$/: required(string)

    key is the error type, and value contains error details

Example:

{
  "description": "Bad Content-Type"
}

HTTP status code 422

Invalid request

Body

Media type: application/problem+json;charset=utf-8

Type: object

• description: required(string)
• id: (string)
• errors: (object)

  key value error type

  • /^.+$/: required(string)

    key is the error type, and value contains error details

Example:

{
  "description": "Validation error message"
}

HTTP status code 424

Claim has expired and needs to be reasserted before scheduling domain control assertion

Body

Media type: application/problem+json;charset=utf-8

Type: object

• description: required(string)
• id: (string)
• errors: (object)

  key value error type

  • /^.+$/: required(string)

    key is the error type, and value contains error details

Example:

{
  "description": "Claim expired. Reassert first"
}

HTTP status code 503

System temporarily cannot process the request

Body

Media type: application/problem+json;charset=utf-8

Type: object

• description: required(string)
• id: (string)
• errors: (object)

  key value error type

  • /^.+$/: required(string)

    key is the error type, and value contains error details

Example:

{
  "description": "Service busy, please retry later",
  "id": "0vqe8FWeDe4DQ7rU7wbzzGmPc4B"
}

HTTP status code 200

Return the list of authorised email addresses

Body

Media type: application/json;charset=utf-8

Type: object

• constructed: required(array of string)
• dns: required(object)

  DNS section of the response for domain control assertion over email. It contains the DNS results for all queried record types. Record types will be the keys of the map (currently only SOA supported).

  • /^.+$/: required(object)

    Contains the emails and errors found for the DNS record type queried for a given domain and all its ADNs.

    • emails: required(array of string)
    • errors: (array of string)

    Example:

    {
      "emails": [
        "test@example.com"
      ],
      "errors": [
        "error retrieving SOA record for \"my.example.com\""
      ]
    }

  Example:

  {
    "SOA": {
      "emails": [
        "test@example.com"
      ]
    }
  }

Example:

{
  "constructed": [
    "admin@test.com",
    "administrator@test.com",
    "webmaster@test.com",
    "hostmaster@test.com",
    "postmaster@test.com"
  ],
  "dns": {
    "SOA": {
      "emails": [
        "example@test.com"
      ]
    }
  }
}

HTTP status code 401

Request is unauthorized

Body

Media type: application/problem+json;charset=utf-8

Type: object

• description: required(string)
• id: (string)
• errors: (object)

  key value error type

  • /^.+$/: required(string)

    key is the error type, and value contains error details

Example:

{
  "description": "Unauthorized"
}

HTTP status code 503

System temporarily cannot process the request

Body

Media type: application/problem+json;charset=utf-8

Type: object

• description: required(string)
• id: (string)
• errors: (object)

  key value error type

  • /^.+$/: required(string)

    key is the error type, and value contains error details

Example:

{
  "description": "Service busy, please retry later",
  "id": "0vqe8FWeDe4DQ7rU7wbzzGmPc4B"
}

HTTP status code 201

Email domain control assertion request for the domain was created

Headers

• Content-Length: required(integer - default: 0)

  This response does not return a body

HTTP status code 202

A previous domain control assertion request is pending

Body

Media type: application/json;charset=utf-8

Type: object

• description: required(string)
• id: (string)
• errors: (object)

  key value error type

  • /^.+$/: required(string)

    key is the error type, and value contains error details

Example:

{
  "description": "Operation in progress"
}

HTTP status code 204

Domain control assertion request verified

HTTP status code 401

Request is unauthorized

Body

Media type: application/problem+json;charset=utf-8

Type: object

• description: required(string)
• id: (string)
• errors: (object)

  key value error type

  • /^.+$/: required(string)

    key is the error type, and value contains error details

Example:

{
  "description": "Unauthorized"
}

HTTP status code 411

Request Content-Length is absent or 0

Body

Media type: application/problem+json;charset=utf-8

Type: object

• description: required(string)
• id: (string)
• errors: (object)

  key value error type

  • /^.+$/: required(string)

    key is the error type, and value contains error details

Example:

{
  "description": "Content-Length required"
}

HTTP status code 415

Request content type is not application/json;charset=utf-8

Body

Media type: application/problem+json;charset=utf-8

Type: object

• description: required(string)
• id: (string)
• errors: (object)

  key value error type

  • /^.+$/: required(string)

    key is the error type, and value contains error details

Example:

{
  "description": "Bad Content-Type"
}

HTTP status code 422

Invalid request

Body

Media type: application/problem+json;charset=utf-8

Type: object

• description: required(string)
• id: (string)
• errors: (object)

  key value error type

  • /^.+$/: required(string)

    key is the error type, and value contains error details

Example:

{
  "description": "Validation error message"
}

HTTP status code 424

Claim has expired and needs to be reasserted before scheduling domain control assertion

Body

Media type: application/problem+json;charset=utf-8

Type: object

• description: required(string)
• id: (string)
• errors: (object)

  key value error type

  • /^.+$/: required(string)

    key is the error type, and value contains error details

Example:

{
  "description": "Claim expired. Reassert first"
}

HTTP status code 429

Request rate exceeded the set limit

Body

Media type: application/problem+json;charset=utf-8

Type: object

• description: required(string)
• id: (string)
• errors: (object)

  key value error type

  • /^.+$/: required(string)

    key is the error type, and value contains error details

Example:

{
  "description": "Rate Limit Reached"
}

HTTP status code 503

System temporarily cannot process the request

Body

Media type: application/problem+json;charset=utf-8

Type: object

• description: required(string)
• id: (string)
• errors: (object)

  key value error type

  • /^.+$/: required(string)

    key is the error type, and value contains error details

Example:

{
  "description": "Service busy, please retry later",
  "id": "0vqe8FWeDe4DQ7rU7wbzzGmPc4B"
}

HTTP status code 200

Reassert request successful, returns the new token and the assert_by timestamp associated to the claim

Headers

• Location: required(string)

  The URL of the existing domain claim

  Example:

  /claims/domains/{claimID}

Body

Media type: application/json;charset=utf-8

Type: object

• token: required(string)

  The token value received is composed of the globalsign prefix followed by the random value generated

  Example:

  globalsign-domain-verification=A477A8393D17A55ECB2BA6A61F58FEB8

• assert_by: required(integer)

Example:

{
  "token": "globalsign-domain-verification=A477A8393D17A55ECB2BA6A61F58FEB8",
  "assert_by": 1524570139
}

HTTP status code 202

A previous DNS domain control assertion request is pending for this claim

Body

Media type: application/json;charset=utf-8

Type: object

• description: required(string)
• id: (string)
• errors: (object)

  key value error type

  • /^.+$/: required(string)

    key is the error type, and value contains error details

Example:

{
  "description": "Operation in progress"
}

HTTP status code 401

Request is unauthorized

Body

Media type: application/problem+json;charset=utf-8

Type: object

• description: required(string)
• id: (string)
• errors: (object)

  key value error type

  • /^.+$/: required(string)

    key is the error type, and value contains error details

Example:

{
  "description": "Unauthorized"
}

HTTP status code 422

Invalid request

Body

Media type: application/problem+json;charset=utf-8

Type: object

• description: required(string)
• id: (string)
• errors: (object)

  key value error type

  • /^.+$/: required(string)

    key is the error type, and value contains error details

Example:

{
  "description": "Validation error message"
}

HTTP status code 503

System temporarily cannot process the request

Body

Media type: application/problem+json;charset=utf-8

Type: object

• description: required(string)
• id: (string)
• errors: (object)

  key value error type

  • /^.+$/: required(string)

    key is the error type, and value contains error details

Example:

{
  "description": "Service busy, please retry later",
  "id": "0vqe8FWeDe4DQ7rU7wbzzGmPc4B"
}