Структуры

Объект ключа доступа

Объект ключа доступа содержит информацию о ключе API или об URL-адресе ACME.

Имя Тип Описание
id int ИД ключа.
user object Подробные сведения о пользователе, связанном с ключом.
.. id int ИД пользователя.
.. first_name string Имя пользователя.
.. last_name string Фамилия пользователя.
status string Состояние ключа.
Допустимые значения: active, revoked
create_date string Временная метка с указанием времени создания ключа.
Формат: Часовой пояс UTC (универсальное глобальное время) и дата в формате ISO 8601
last_used_date string Временная метка последнего использования ключа.
Формат: Часовой пояс UTC (универсальное глобальное время) и дата в формате ISO 8601
name string Имя ключа.
is_legacy bool Унаследованный статус ключа.
restricted_to_role_id int Указывается, если разрешения ключа API ограничены в отношении заданного набора действий.
См. Словарь — Типы ключей API
acme_directory_url string Замаскированный URL-адрес каталога ACME.
Возвращается только для ключей ACME.
product_name_id string ИД имени продукта, заказанного через ACME.
Возвращается только для ключей ACME.
См. Словарь — Идентификаторы продуктов
product_name string Понятное имя продукта, заказанного через ACME.
Возвращается только для ключей ACME.
См. Словарь — Идентификаторы продуктов
organization_id string Идентификатор организации, связанный с заказами сертификатов через ACME.
Возвращается только для ключей ACME.
organization_name string Название организации, связанное с заказами сертификатов через ACME.
Возвращается только для ключей ACME.
validity_days string Число дней, в течение которых сертификат будет действительным.
Возвращается только для ключей ACME.
validity_years string Число лет, в течение которых сертификат будет действительным.
Возвращается только для ключей ACME.

Объект сведений о контактном лице

Объект сведений о контактном лице содержит контактную информацию об организации или контактном лице по техническим вопросам.

Имя Тип Описание
first_name string Имя контактного лица.
last_name string Фамилия контактного лица.
email string Адрес электронной почты контактного лица.
job_title string Название должности контактного лица.
telephone string Номер телефона контактного лица.
telephone_extension string Добавочный телефонный номер, используемый для связи с контактным лицом.

Объект сведений о странице

Имя Тип Описание
total int Общее количество найденных результатов.
limit int Результаты, усеченные до указанного номера.
Модифицировать, используя строку запросов лимита.
Макс.: 1000
По умолчанию: 1000
offset int Результаты начинаются с указанного номера.
Модифицировать, используя строку запросов лимита.
По умолчанию: 0

Объект сведений о пользователе

Объект сведений о пользователе содержит базовую информацию об указанном пользователе. В зависимости от конечной точки, не все параметры будут возвращаться.

Имя Тип Описание
id int ИД пользователя.
username string Имя пользователя, используемое для входа.
account_id int Учетная запись, к которой прикреплен пользователь.
first_name string Имя пользователя.
last_name string Фамилия пользователя.
email string Адрес электронной почты пользователя.
status string Активный статус пользователя.

Объект проверок

Объект проверок содержит информацию о статусе проверки организации или домена.

Имя Тип Описание
type string Идентификатор типа проверки.
См. Словарь — Типы проверок
name string Имя типа проверки.
description string Описание типа проверки.
date_created string Временная метка с указанием времени проверки домена.
Формат: Часовой пояс UTC (универсальное глобальное время) и дата в формате ISO 8601
validated_until string Временная метка с указанием срока действия результатов проверки домена.
Формат: Часовой пояс UTC (универсальное глобальное время) и дата в формате ISO 8601
status string Статус проверки.
Допустимые значения: pending, active, expired
dcv_status string Статус подтверждения полномочий управления доменом.
Допустимые значения: pending, complete, expired
org_status string Статус проверки организации.
Допустимые значения: pending, complete, expired
verified_users string Список пользователей, которые были проверены с использованием данного отдельного типа проверки.
См. Объект сведений о контактном лице

Объект типов проверок

Объект типов проверок содержит информацию об определенном типе проверки, используемом при проверке как организации, так и домена.

Имя Тип Описание
type string Идентификатор типа проверки.
name string Имя типа проверки.
description string Описание типа проверки.
requires_user bool Указывает, требует ли тип проверки подтверждения действительности пользователя.
requires_dcv bool Указывает, требует ли тип проверки подтверждения управления доменом (DCV).
Возвращается только с типами подтверждения доменов.