Estruturas

Objeto da chave de acesso

O objeto da chave de acesso possui informações sobre uma chave de API ou URL ACME.

Nome Tipo Descrição
id int ID da chave.
user object Detalhes sobre o usuário vinculado à chave.
.. id int ID de usuário.
.. first_name string Primeiro nome do usuário.
.. last_name string Sobrenome do usuário.
status string Status da chave.
Valores possíveis: active, revoked
create_date string Carimbo de data/hora de quando a chave foi criada.
Formato: Fuso horário UTC e data ISO 8601
last_used_date string Carimbo de data/hora da última vez que a chave foi usada.
Formato: Fuso horário UTC e data ISO 8601
name string Nome da chave.
is_legacy bool Status herdado da chave.
restricted_to_role_id int Especifica se as permissões da chave de API estão restritas a um conjunto definido de ações.
Veja Glossário — Funções da chave de API
acme_directory_url string URL ofuscada do diretório ACME.
Retornada apenas para chaves ACME.
product_name_id string ID do nome do produto pedido através da ACME.
Retornada apenas para chaves ACME.
Veja Glossário — Identificadores de produtos
product_name string Nome amigável do produto pedido através da ACME.
Retornada apenas para chaves ACME.
Veja Glossário — Identificadores de produtos
organization_id string ID da organização associada a pedidos de certificados através da ACME.
Retornada apenas para chaves ACME.
organization_name string Nome da organização associada a pedidos de certificados através da ACME.
Retornada apenas para chaves ACME.
validity_days string Número de dias que o certificado será válido.
Retornada apenas para chaves ACME.
validity_years string Número de anos que o certificado será válido.
Retornada apenas para chaves ACME.

Objeto de detalhes de contatos

O objeto de detalhes de contas possui informações sobre um contato da organização ou técnico.

Nome Tipo Descrição
first_name string Primeiro nome do contato.
last_name string Sobrenome do contato.
email string Endereço de e-mail do contato.
job_title string Cargo de trabalho do contato.
telephone string Número de telefone do contato.
telephone_extension string Ramal de telefone usado para alcançar o contato.

Objeto de detalhes da página

Nome Tipo Descrição
total int Número total de resultados encontrados.
limit int Resultados truncados ao número especificado.
Modifique usando o limite da cadeia de consulta.
Máx: 1000
Padrão: 1000
offset int Resultados iniciam no número especificado.
Modifique usando o limite da cadeia de consulta.
Padrão: 0

Objeto de detalhes do usuário

O objeto de detalhes do usuário possui informações básicas sobre um usuário específico. Dependendo do ponto de extremidade, nem todos os parâmetros serão retornados.

Nome Tipo Descrição
id int ID de usuário.
username string Nome de usuário usado para entrar.
account_id int Conta à qual o usuário está anexado.
first_name string Primeiro nome do usuário.
last_name string Sobrenome do usuário.
email string Endereço de e-mail do usuário.
status string Status ativo do usuário.

Objeto de validações

O objeto de validações possui informações de status da validação para uma organização ou domínio.

Nome Tipo Descrição
type string Identificador do tipo de validação.
Veja Glossário — Tipos de validação
name string Nome do tipo de validação.
description string Descrição do tipo de validação.
date_created string Carimbo de data/hora de quando o domínio foi validado.
Formato: Fuso horário UTC e data ISO 8601
validated_until string Carimbo de data/hora de quando a validação do domínio vencerá.
Formato: Fuso horário UTC e data ISO 8601
status string Status da validação.
Valores possíveis: pending, active, expired
dcv_status string Status da validação de controle do domínio.
Valores possíveis: pending, complete, expired
org_status string Status de validação da organização.
Valores possíveis: pending, complete, expired
verified_users string Lista de usuários que foram verificados para o determinado tipo de validação.
Veja Objeto de detalhes de contatos

Objeto dos tipos de validação

O objeto dos tipos de validação possui informações sobre um tipo de validação específico usado para a validação da organização e domínio.

Nome Tipo Descrição
type string Identificador do tipo de validação.
name string Nome do tipo de validação.
description string Descrição do tipo de validação.
requires_user bool Identifica se o tipo de validação exige validação do usuário.
requires_dcv bool Identifica se o tipo de validação exige validação do controle do domínio.
Retornado apenas com tipos de validação do domínio.