The access key object contains information about an API key or ACME URL.
Name | Type | Description |
---|---|---|
id | int | Key ID. |
user | object | Details about the user linked to the key. |
.. id | int | User ID. |
.. first_name | string | First name of user. |
.. last_name | string | Last name of user. |
status | string |
Key status. Possible values: active , revoked
|
create_date | string |
Timestamp of when the key was created. Format: UTC timezone and ISO 8601 date |
last_used_date | string |
Timestamp of the last time the key was used. Format: UTC timezone and ISO 8601 date |
name | string | Name of the key. |
is_legacy | bool | Legacy status of the key. |
restricted_to_role_id | int |
Specifies if the API key permissions are restricted to a defined set of actions. See Glossary – API key roles |
acme_directory_url | string |
Obfuscated ACME directory URL. Only returned for ACME keys. |
product_name_id | string |
Name ID of the product ordered via ACME. Only returned for ACME keys. See Glossary – Product identifiers |
product_name | string |
Friendly name of the product ordered via ACME. Only returned for ACME keys. See Glossary – Product identifiers |
organization_id | string |
Organization ID associated with certificate orders via ACME. Only returned for ACME keys. |
organization_name | string |
Organization name associated with certificate orders via ACME. Only returned for ACME keys. |
validity_days | string |
Number of days the certificate will be valid. Only returned for ACME keys. |
validity_years | string |
Number of years the certificate will be valid. Only returned for ACME keys. |
The contact details object contains information about an organization or technical contact.
Name | Type | Description |
---|---|---|
first_name | string | First name of the contact. |
last_name | string | Last name of the contact. |
string | Email address of the contact. | |
job_title | string | Job title of the contact. |
telephone | string | Telephone number for the contact. |
telephone_extension | string | Telephone extension used to reach the contact. |
Name | Type | Description |
---|---|---|
total | int | Total number of results found. |
limit | int |
Results truncated to the specified number. Max: 1000 Default: 1000
|
offset | int |
Results start at the specified number. Default: 0
|
The user details object contains basic information about a specific user. Depending on the endpoint, not all parameters will be returned.
Name | Type | Description |
---|---|---|
id | int |
User ID. User ID is 0 if the user is a guest.
|
username | string | Username used to sign in. |
account_id | int | Account the user is attached to. |
first_name | string | First name of user. |
last_name | string | Last name of user. |
string | Email address of user. | |
status | string | Active status of the user. |
The validations object contains validation status information for an organization or domain.
Name | Type | Description |
---|---|---|
type | string |
Validation type identifier. See Glossary – Validation types |
name | string | Name of the validation type. |
description | string | Description of the validation type. |
date_created | string |
Timestamp of when the domain was validated. Format: UTC timezone and ISO 8601 date |
validated_until | string |
Timestamp of when the domain validation will expire. Format: UTC timezone and ISO 8601 date |
status | string |
Status of the validation. Possible values: pending , active , expired
|
dcv_status | string |
Domain control validation status. Possible values: pending , complete , expired
|
org_status | string |
Organization validation status. Possible values: pending , complete , expired
|
verified_users | string |
List of users that have been verified for the particular validation type. See Contact details object |
The validation types object contains information about a specific validation type used for both organization and domain validation.
Name | Type | Description |
---|---|---|
type | string | Validation type identifier. |
name | string | Name of the validation type. |
description | string | Description of the validation type. |
requires_user | bool | Identifies if the validation type requires user validation. |
requires_dcv | bool |
Identifies if the validation type requires domain control validation (DCV). Only returned with domain validation types. |