order_details

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

このクエリを使用して、証明書オーダーについての詳細を取得します。

単一証明書オーダーについての詳細を取得するには、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"
            }
        ]
    }
}

引数

データをフィルタリング、検索または操作するクエリ引数を含めます。複数の引数はコンマで区切ります。ソート を例外として、,すべての引数は key:value 形式 (例. status:"issued") を使用しています。

フィルター

フィルター引数を使用して、クエリデータを指定のパラメータ値に絞り込みます。複数のフィルターを使用して、結果をさらに絞り込むことができます。

名前 申請/オプション 種別 説明
id 任意 int オーダー ID
status 任意 string オーダーステータス
「用語集 — オーダーステータス」を参照してください
valid_from 任意 string 証明書有効期間開始時の日付
形式:yyyy-MM-dd
オペレータ:>=
valid_till 任意 string 証明書有効期間終了時の日付。
形式:yyyy-MM-dd
オペレータ:<=
container_id 任意 string コンテナ ID
organization_id 任意 string 組織 ID.
product_name_id 任意 string 製品の名前 ID
「用語集 — 製品識別子」を参照してください
serial_number 任意 string 証明書のシリアル番号
signature_hash 任意 string 証明書申請の署名に使用する署名ハッシュ
user_id 任意 string オーダーを実行したユーザーの ID
date_created 任意 string オーダーを実行した日付
形式:yyyy-MM-dd HH:mm:ss
オペレータ:>=
ca_cert_id 任意 string 発行認証局の ID
common_name 任意 string 証明書が安全保護する名前
%like オペレータに使用します (例. common_name:"%example.com").
dns_names 任意 string 証明書が安全保護する追加名のリスト
locale 任意 string オーダーの場所
「用語集 — ローカルコード」を参照してください
thumbprint 任意 string 証明書のサムプリント
email 任意 string カスタムオーダーメール

検索

検索引数を使用して、検索済フィールドに含まれる個別文字列を探します。

名前 申請/オプション 種別 説明
search 任意 string 含まれる文字列の個別フィールドを探します。
%like オペレータに使用します (例. search:"%example.com").
検索済フィールド:id, status, container_id, organization_id, product_name_id, additional_emails, organization_name, product_name, serial_number, user_id, common_name, email

ソートとページネーション

ソートとページネーション引数を使用して、返されたクエリ結果を操作します。

名前 申請/オプション 種別 説明
ソート 任意 アレイ ソートフィールドとディレクションを指定します。
形式:["{{field}}","{{direction}}"]
すべての許可値 (フィールド):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
すべての許可値 (ディレクション):ASC,DESC
デフォルト:["id","DESC"]
offset 任意 int ページネーション用にリストを指定番号からはじめます。
デフォルト:0
limit 任意 int ページネーション用にリストを指定番号に切り捨てます。
最大:1000(デフォルト)

フィールド

申請に、少なくとも1つのフィールドが含まれていなければなりません。フィールドを何も送信しない場合、シンタックスエラーが返されます。

当該のフィールドについてデータが存在しない場合は、null エラーが返されます。

名前 種別 説明
account_id string オーダーに関連づけられたアカウント ID
additional_emails string オーダー上の追加メールアドレス
agreement_id string 同意した CSA の ID
auto_renew string 証明書が自動更新する場合に指定します。
可能な値:0 (無効)、1 (有効)
ca_cert_id string 発行認証局の ID
certificate_tracker_id string 証明書 ID
common_name string 証明書が安全保護する名前
contacts_email string 組織連絡先のメールアドレス
container_id string オーダーの ID
container_name string オーダーのコンテナ名
cost string オーダーコスト
csr string 証明書署名申請 (CSR).
custom_renewal_message string 更新通知に含めるカスタムメッセージ
customer_order_id string カスタムオーダー ID
date_created string オーダーを実行した日付
形式:yyyy-MM-dd HH:mm:ss
dcv_method string ドメイン用に構成されたドメイン名糊王権確認方法
「用語集 — DCV 方法」を参照してください。
disable_issuance_email string 発行メールを送信する場合に指定します。
可能な値:0 (偽)、1 (真)
disable_renewal_notifications string 更新通知を有効にする場合に指定します。
可能な値:0 (偽)、1 (真)
dns_names string 証明書が安全保護する追加名をコンマで区切ったリスト
email string 証明書に埋め込みメールアドレスがある (例. クライアント証明書) 場合、証明書にメールアドレスが返されます。
firstname string 組織連絡先の名
has_duplicates int 証明書に複製がある場合に指定します。
可能な値:0 (偽)、1 (真)
id string オーダー ID
is_out_of_contract string オーダーの契約ステータス
可能な値:0 (偽)、1 (真)
is_renewed string オーダーを更新した場合に指定します。
可能な値:0 (偽)、1 (真)
issuer_common_name string 発行認証局の使いやすい名前
job_title string 組織連絡先の役職
lastname string 組織連絡先の姓
locale string オーダーの場所
「用語集 — ローカルコード」を参照してください
メタデータ 文字列 カスタムフィールド詳細
形式:{{metadata_id}} {{metadata_label}} {{metadata_value}}データセパレータ:0x1f
org_addr1 string 組織の住所
org_addr2 string
organization_city string 組織の所在市町村
organization_country string 組織の所在国
organization_id string オーダーと関連づけられた組織 ID
organization_name string 組織名
organization_state string 組織の所在州(都道府県)
organization_unit string 証明書上の組織部門
pay_type string オーダーに使用する支払方法
可能な値:A (アカウント残高)、C (クレジットカード)
plus_feature string プラス機能がオーダーについて有効になっている場合に指定します。
可能な値:0 (無効)、1 (有効)
product_id string 製品の ID
product_name string 製品の表示名
「用語集 — 製品識別子」を参照してください
product_name_id string 製品の名前 ID
「用語集 — 製品識別子」を参照してください
product_type string 製品タイプ
「用語集 — 製品タイプ」を参照してください
purchased_dns_names string 購入した追加 SAN の数
receipt_id string 受取 ID
Renewed string オーダーを更新した場合に指定します。
可能な値:FALSE,TRUE
renewed_order_id string 前のオーダーのオーダー ID
オーダーが更新の場合にのみ返されます。
serial_number string 証明書のシリアル番号
serversw string サーバープラットフォーム ID
「用語集 — サーバープラットフォーム」を参照してください
signature_hash string 証明書申請の署名に使用する署名ハッシュ
status string オーダーステータス
「用語集 — オーダーステータス」を参照してください
telephone string 組織連絡先の電話番号
thumbprint string 証明書のサムプリント
user_assignments string オーダーに割り当てられたユーザーの ID
user_email string 証明書を申請したユーザーのメールアドレス
user_first_name string 証明書を申請したユーザーの名
user_id string オーダーを実行したユーザーの ID
user_last_name string 証明書を申請したユーザーの姓
valid_from string 証明書有効期間開始時の日付
形式:yyyy-MM-dd
valid_till string 証明書有効期間終了時の日付。
形式:yyyy-MM-dd
validity_years string 証明書が有効な年数。

応答パラメータ

名前 種別 説明
data object 返されたクエリデータ用コンテナ
.. order_details array クエリフィールドを含むオーダーオブジェクトのリスト
.. .. {{フィールド}} - クエリフィールドと値
送信済クエリに依存し、返されたフィールド.