order_details

QUERY
https://www.digicert.com/services/v2/reports/query

Use esta consulta para obter detalhes específicos para todos os pedidos de certificados.

Para obter detalhes específicos para um único pedido de certificado, use a consulta order_details_by_id.

GraphQL
{
    order_details(valid_till:"2020-10-26",limit:5,sort:["valid_from","DESC"]) {
        id
        common_name
        dns_names
        organization_id
        status
        valid_from
        valid_till
    }
}
200 OK
{
    "data": {
        "order_details": [
            {
                "id": "123456",
                "common_name": "digicert.com",
                "dns_names": null,
                "organization_id": "112233",
                "status": "issued",
                "valid_from": "2019-10-04",
                "valid_till": "2020-10-08"
            },
            {
                "id": "123458",
                "common_name": "dev.digicert.com",
                "dns_names": null,
                "organization_id": "223344",
                "status": "issued",
                "valid_from": "2019-10-03",
                "valid_till": "2020-10-07"
            },
            {
                "id": "123443",
                "common_name": "example.com",
                "dns_names": "sub.example.com,www.example.com",
                "organization_id": "112233",
                "status": "revoked",
                "valid_from": "2019-10-02",
                "valid_till": "2020-10-06"
            },
            {
                "id": "123460",
                "common_name": "example.net",
                "dns_names": "www.example.net",
                "organization_id": "112233",
                "status": "issued",
                "valid_from": "2019-09-30",
                "valid_till": "2020-10-07"
            },
            {
                "id": "123424",
                "common_name": "example.org",
                "dns_names": "test.example.org,monitor.example.org,api.example.org",
                "organization_id": "334455",
                "status": "issued",
                "valid_from": "2019-09-27",
                "valid_till": "2020-10-01"
            }
        ]
    }
}

Argumentos

Inclua argumentos de consulta para filtrar, pesquisar ou manipular dados. Separe múltiplos argumentos usando vírgulas. Com a exceção de sort, todos os argumentos usam um formato key:value (por ex., status:"issued").

Filtros

Use argumentos do filtro para especificar dados da consulta para valores de parâmetros especificados. Múltiplos filtros podem ser usados para especificar ainda mais os resultados.

Nome Obr/Opc Tipo Descrição
id opcional int ID do pedido.
status opcional string Status do pedido.
Veja Glossário — Status do pedido
valid_from opcional string Data quando a validade do certificado começa.
Formato: yyyy-MM-dd
Operador: >=
valid_till opcional string Data quando a validade do certificado termina.
Formato: yyyy-MM-dd
Operador: <=
container_id opcional string ID do recipiente.
organization_id opcional string ID da organização.
product_name_id opcional string ID do nome do produto.
Veja Glossário — Identificadores de produtos
serial_number opcional string Número de série do certificado.
signature_hash opcional string Hash de assinatura usado para assinar a solicitação do certificado.
user_id opcional string ID do usuário que fez o pedido.
date_created opcional string Data quando o pedido foi feito.
Formato: yyyy-MM-dd HH:mm:ss
Operador: >=
ca_cert_id opcional string ID da autoridade de certificado em emissão.
common_name opcional string Nome protegido pelo certificado.
Use % para um operador like (por ex., common_name:"%example.com").
dns_names opcional string Lista de nomes adicionais protegidos pelo certificado.
locale opcional string Local do pedido.
Veja Glossário — Códigos de localidades
thumbprint opcional string Impressão digital do certificado.
email opcional string E-mail do pedido do cliente.

Pesquisar

Use argumento de pesquisa para encontrar uma string específica contida nos campos pesquisados.

Nome Obr/Opc Tipo Descrição
search opcional string Pesquise campos específicos para a string incluída.
Use % para um operador like (por ex., search:"%example.com").
Campos pesquisados: id, status, container_id, organization_id, product_name_id, additional_emails, organization_name, product_name, serial_number, user_id, common_name, email

Ordenar e paginação

Use os argumentos de ordenação e paginação para manipular os resultados retornados da consulta.

Nome Obr/Opc Tipo Descrição
ordenar opcional matriz Especifique o campo de ordenação e direção.
Formato: ["{{field}}","{{direction}}"]
Valores permitidos (campo): valid_till, container_id, organization_id, product_name_id, serial_number, signature_hash, user_id, date_created, ca_cert_id, common_name, dns_names, locale, thumbprint, email
Valores permitidos (direção): ASC, DESC
Padrão: ["id","DESC"]
offset opcional int Comece a lista no número especificado para paginação.
Padrão: 0
limit opcional int Trunque a lista ao número especificado para paginação.
Máx: 1000 (padrão)

Campos

Ao menos um campo deve ser incluído na solicitação. Se nenhum campo for enviado, um erro de sintaxe é retornado.

Se nenhum dado existir para o campo, um valor null é retornado.

Nome Tipo Descrição
account_id string ID da conta associada ao pedido.
additional_emails string Endereços adicionais de e-mail no pedido.
agreement_id string ID com a qual a CSA concordou.
auto_renew string Especifica se o certificado deve renovar automaticamente.
Valores possíveis: 0 (desabilitado), 1 (habilitado)
ca_cert_id string ID da autoridade de certificado em emissão.
certificate_tracker_id string ID do Certificado.
common_name string Nome protegido pelo certificado.
contacts_email string Endereço de e-mail do contato da organização.
container_id string ID do recipiente do pedido.
container_name string Nome do recipiente do pedido.
cost string Custo do pedido.
csr string Solicitação de Assinatura de Certificado (CSR).
custom_renewal_message string Mensagem personalizada incluída em notificações de renovação.
customer_order_id string ID do campo personalizado.
date_created string Data quando o pedido foi feito.
Formato: yyyy-MM-dd HH:mm:ss
dcv_method string Método de validação de controle do domínio configurado para o domínio.
Consulte Glossário — Métodos DCV
disable_issuance_email string Especifica se e-mails de emissão são enviados.
Valores possíveis: 0 (falso), 1 (verdadeiro)
disable_renewal_notifications string Especifica se notificações de renovação estão habilitadas.
Valores possíveis: 0 (falso), 1 (verdadeiro)
dns_names string Lista separada por vírgula de nomes adicionais protegidos pelo certificado.
email string Se o certificado tiver um endereço de e-mail incorporado (por ex., certificados do cliente), retorna o endereço de e-mail no certificado.
firstname string Primeiro nome do contato da organização.
has_duplicates int Especifica se o certificado tem duplicatas.
Valores possíveis: 0 (falso), 1 (verdadeiro)
id string ID do pedido.
is_out_of_contract string Status do contrato do pedido.
Valores possíveis: 0 (falso), 1 (verdadeiro)
is_renewed string Especifica se o pedido foi renovado.
Valores possíveis: 0 (falso), 1 (verdadeiro)
issuer_common_name string Nome amigável da autoridade de certificado em emissão.
job_title string Cargo de trabalho do contato da organização.
lastname string Sobrenome do contato da organização.
locale string Local do pedido.
Veja Glossário — Códigos de localidades
metadados string Detalhes do campo personalizado.
Formato: {{metadata_id}} {{metadata_label}} {{metadata_value}}Separador de dados: 0x1f
org_addr1 string Endereço da organização.
org_addr2 string
organization_city string Cidade onde a organização está localizada.
organization_country string País onde a organização está localizada.
organization_id string ID da organização associada ao pedido.
organization_name string Nome da organização.
organization_state string Estado onde a organização está localizada.
organization_unit string Unidades da organização no certificado.
pay_type string Método de pagamento usado para o pedido.
Valores possíveis: A (saldo da conta), C (cartão de crédito)
plus_feature string Especifica se o recurso plus está habilitado para o pedido.
Valores possíveis: 0 (desabilitado), 1 (habilitado)
product_id string ID do produto.
product_name string Exibe o nome do produto.
Veja Glossário — Identificadores de produtos
product_name_id string ID do nome do produto.
Veja Glossário — Identificadores de produtos
product_type string Tipo do produto.
Veja Glossário — Tipos de produtos
purchased_dns_names string Número de SANs adicionais compradas.
receipt_id string ID do recibo.
Renewed string Especifica se o pedido foi renovado.
Valores possíveis: FALSE, TRUE
renewed_order_id string ID do pedido do pedido anterior.
Retornado apenas se o pedido for uma renovação.
serial_number string Número de série do certificado.
serversw string ID da plataforma do servidor.
Veja Glossário — Plataformas do servidor
signature_hash string Hash de assinatura usado para assinar a solicitação do certificado.
status string Status do pedido.
Veja Glossário — Status do pedido
telephone string Número de telefone do contato da organização.
thumbprint string Impressão digital do certificado.
user_assignments string ID do usuário atribuído ao pedido.
user_email string Endereço de e-mail do usuário que solicitou o certificado.
user_first_name string Primeiro nome do usuário que solicitou o certificado.
user_id string ID do usuário que fez o pedido.
user_last_name string Sobrenome do usuário que solicitou o certificado.
valid_from string Data quando a validade do certificado começa.
Formato: yyyy-MM-dd
valid_till string Data quando a validade do certificado termina.
Formato: yyyy-MM-dd
validity_years string Número de anos que o certificado é válido.

Parâmetros da resposta

Nome Tipo Descrição
data object Recipiente para dados retornados da consulta.
.. order_details array Lista de objetos do pedido contendo campos consultados.
.. .. {{campo}} - Campo e valor consultados.
Campos retornados dependentes da consulta enviada.