Oracle Integration 3のDeveloper API

機械翻訳について

証明書の取得

get

/ic/api/integration/v1/certificates

すべての証明書に関する情報を取得します。

リクエスト

問合せパラメータ

expand: string

レスポンスに証明書に関する追加の詳細が含まれます。
integrationInstance(required): string

これはサービス・インスタンスの名前です。この値は、サービス・インスタンス・フィールドで指定した情報ページから取得できます。
limit: integer(int32)

返される結果のページ区切りには、オフセット・パラメータを使用します。この制限は、一度に返すアイテムの最大数です。たとえば、offset=3&limit=16は4番目の項目から始まる証明書をリストすることを示し、リストには16個の項目が含まれます。
offset: integer(int32)

戻される結果のページ区切りには、制限パラメータを使用します。オフセットは、レコードを返す開始ポイントです。たとえば、offset=3&limit=16は4番目の項目から始まる証明書をリストすることを示し、リストには16個の項目が含まれます。
orderBy: string
証明書を名前または失効順にリストします。
有効な値:
- name: 証明書を証明書名で並べ替えます。例: orderBy=name.
- expiry: 証明書を後で有効期限までにオーダーします。例: orderBy=expiry.
- expiry:asc: 有効期限が早いほど証明書をオーダーします。例: orderBy=expiry:asc
q: string
証明書を名前、ステータスおよびタイプでフィルタします。
有効なパラメータ:
- name: 証明書の名前。完全一致または次をサポートします。たとえば:
  - 証明書名で完全一致の証明書を取得するには、次を指定します:
    q={name:'My Certificate Name'}
    .
  - 証明書名に指定された文字列を含むすべての証明書を取得するには、次を指定します:
    q={name: /Oracle/}
- status: 証明書のステータス。有効な値: CONFIGURED, INPROGRESS. INPROGRESSは、グラフィカル・ユーザー・インタフェースでドラフトとして表示されます。
  たとえば、PGPを含むすべての証明書を取得し、ステータスが構成されている場合は、次のように指定します:
```
{name : /PGP/, status : 'CONFIGURED'}
```
- type: 証明書のタイプ。
  有効な値: DIGITALSIGNATURE、PGP、SAML、SIGNKEY、X509。
return: string

APIは、レスポンスの最小ビューまたは全体ビューを返します。

この操作のリクエスト本文がありません。

トップに戻る

レスポンス

サポートされているメディア・タイプ

application/json; charset=utf-8, application/vnd.oracle.resource+json;type=collection

200レスポンス

操作の成功

ルート・スキーマ : CertificatesRs

すべてに一致

ソースを表示

object GenericRestRs
object CertificatesRs-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/GenericRestRs"
        },
        {
            "type":"object",
            "properties":{
                "items":{
                    "type":"array",
                    "description":"List of Certificates",
                    "items":{
                        "$ref":"#/components/schemas/CertificateRs"
                    }
                },
                "totalResults":{
                    "type":"integer",
                    "description":"Total Results",
                    "format":"int32"
                },
                "hasMore":{
                    "type":"boolean",
                    "description":"Flag to Check if More Records Exists"
                },
                "limit":{
                    "type":"integer",
                    "description":"Limit of Records to be Displayed",
                    "format":"int32"
                }
            }
        }
    ]
}

ネストされたスキーマ : GenericRestRs

型: object

ソースを表示

links: array links

{
    "type":"object",
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/SuiteLink"
            }
        }
    }
}

ネストされたスキーマ : CertificatesRs-allOf[1]

型: object

ソースを表示

hasMore: boolean

レコードが他に存在するかどうかを確認するフラグ
items: array items

証明書のリスト
limit: integer (int32)

表示するレコードの制限
totalResults: integer (int32)

結果合計

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "description":"List of Certificates",
            "items":{
                "$ref":"#/components/schemas/CertificateRs"
            }
        },
        "totalResults":{
            "type":"integer",
            "description":"Total Results",
            "format":"int32"
        },
        "hasMore":{
            "type":"boolean",
            "description":"Flag to Check if More Records Exists"
        },
        "limit":{
            "type":"integer",
            "description":"Limit of Records to be Displayed",
            "format":"int32"
        }
    }
}

ネストされたスキーマ: links

型: array

ソースを表示

Array of: object SuiteLink

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/SuiteLink"
    }
}

ネストされたスキーマ : SuiteLink

型: object

ソースを表示

href: string
media-type: string
method: string
rel: string

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        },
        "media-type":{
            "type":"string"
        },
        "method":{
            "type":"string"
        }
    }
}

ネストされたスキーマ: items

型: array

証明書のリスト

ソースを表示

Array of: CertificateRs

{
    "type":"array",
    "description":"List of Certificates",
    "items":{
        "$ref":"#/components/schemas/CertificateRs"
    }
}

ネストされたスキーマ : CertificateRs

すべてに一致

ソースを表示

allOf IdResource
object GenericRestResource
object CertificateRs-allOf[2]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/IdResource"
        },
        {
            "$ref":"#/components/schemas/GenericRestResource"
        },
        {
            "type":"object",
            "properties":{
                "keystore":{
                    "type":"string",
                    "description":"Keystore"
                },
                "keyStoreDescription":{
                    "type":"string",
                    "description":"Keystore description"
                },
                "name":{
                    "type":"string",
                    "description":"Certificate alias name"
                },
                "description":{
                    "type":"string",
                    "description":"Certificate description"
                },
                "type":{
                    "type":"string",
                    "description":"Certificate type. Valid values - DIGITALSIGNATURE, PGP, SAML, SIGNKEY & X509"
                },
                "installedType":{
                    "type":"string",
                    "description":"Certificate installed by. Ex - USER"
                },
                "typeDescription":{
                    "type":"string",
                    "description":"Certificate type description"
                },
                "keyPasswords":{
                    "type":"string",
                    "description":"Key password(s). Valid only for type - X509 and category - IDENTITY"
                },
                "keystorePassword":{
                    "type":"string",
                    "description":"Keystore password. Valid only for type - X509 and category - IDENTITY"
                },
                "passPhrase":{
                    "type":"string",
                    "description":"Private key password. Valid only for type - PGP & SIGNKEY and category - PRIVATE"
                },
                "asciiArmored":{
                    "type":"boolean",
                    "description":"ASCII-Armor encryption flag. Valid only for type - PGP and category - PUBLIC"
                },
                "cipherAlgorithm":{
                    "type":"string",
                    "description":"Cipher algorithm. Valid only for type - PGP and category - PUBLIC"
                },
                "issued":{
                    "type":"string",
                    "description":"Certificate issued date",
                    "format":"date-time"
                },
                "expires":{
                    "type":"string",
                    "description":"Certificate expiry date",
                    "format":"date-time"
                },
                "status":{
                    "type":"string",
                    "description":"Certificate status. Ex. - CONFIGURED or INPROGRESS"
                },
                "createdBy":{
                    "type":"string",
                    "description":"Certificate created by"
                },
                "created":{
                    "type":"string",
                    "description":"Certificate created date",
                    "format":"date-time"
                },
                "lastUpdatedBy":{
                    "type":"string",
                    "description":"Certificate updated by"
                },
                "lastUpdated":{
                    "type":"string",
                    "description":"Certificate updated date",
                    "format":"date-time"
                },
                "metaData":{
                    "type":"object",
                    "additionalProperties":{
                        "type":"string"
                    }
                },
                "hash":{
                    "type":"string"
                },
                "content":{
                    "type":"array",
                    "items":{
                        "type":"string",
                        "format":"byte"
                    }
                },
                "secretOCID":{
                    "type":"string"
                }
            }
        }
    ]
}

ネストされたスキーマ : IdResource

すべてに一致

ソースを表示

object GenericRestResource
object IdResource-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/GenericRestResource"
        },
        {
            "type":"object",
            "properties":{
                "projectId":{
                    "type":"string"
                },
                "projectName":{
                    "type":"string"
                },
                "id":{
                    "type":"string"
                }
            }
        }
    ]
}

ネストされたスキーマ : GenericRestResource

型: object

ソースを表示

links: array links
processing-time: number (float)

{
    "type":"object",
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Link"
            }
        },
        "processing-time":{
            "type":"number",
            "format":"float"
        }
    }
}

ネストされたスキーマ : IdResource-allOf[1]

型: object

ソースを表示

id: string
projectId: string
projectName: string

{
    "type":"object",
    "properties":{
        "projectId":{
            "type":"string"
        },
        "projectName":{
            "type":"string"
        },
        "id":{
            "type":"string"
        }
    }
}

ネストされたスキーマ : CertificateRs-allOf[2]

型: object

ソースを表示

asciiArmored: boolean

ASCII-Armor暗号化フラグ。タイプに対してのみ有効 - PGPおよびカテゴリ - PUBLIC
cipherAlgorithm: string

暗号アルゴリズムタイプに対してのみ有効 - PGPおよびカテゴリ - PUBLIC
content: array content
created: string (date-time)

証明書作成日
createdBy: string

証明書作成者
description: string

証明書の説明
expires: string (date-time)

証明書の有効期限
hash: string
installedType: string

証明書のインストール者。 Ex - USER
issued: string (date-time)

証明書発行日
keyPasswords: string

キー・パスワード。タイプに対してのみ有効 - X509およびカテゴリ - IDENTITY
keystore: string

キーストア
keyStoreDescription: string

キーストアの説明
keystorePassword: string

キーストア・パスワード。タイプに対してのみ有効 - X509およびカテゴリ - IDENTITY
lastUpdated: string (date-time)

証明書の更新日
lastUpdatedBy: string

証明書更新者
metaData: object metaData

許可される追加のプロパティ: additionalProperties
name: string

証明書別名
passPhrase: string

秘密キーのパスワードタイプに対してのみ有効 - PGPとSIGNKEYとカテゴリ - PRIVATE
secretOCID: string
status: string

証明書ステータス Ex. - CONFIGUREDまたはINPROGRESS
type: string

証明書タイプ有効な値 - DIGITALSIGNATURE、PGP、SAML、SIGNKEY & X509
typeDescription: string

証明書タイプの説明

{
    "type":"object",
    "properties":{
        "keystore":{
            "type":"string",
            "description":"Keystore"
        },
        "keyStoreDescription":{
            "type":"string",
            "description":"Keystore description"
        },
        "name":{
            "type":"string",
            "description":"Certificate alias name"
        },
        "description":{
            "type":"string",
            "description":"Certificate description"
        },
        "type":{
            "type":"string",
            "description":"Certificate type. Valid values - DIGITALSIGNATURE, PGP, SAML, SIGNKEY & X509"
        },
        "installedType":{
            "type":"string",
            "description":"Certificate installed by. Ex - USER"
        },
        "typeDescription":{
            "type":"string",
            "description":"Certificate type description"
        },
        "keyPasswords":{
            "type":"string",
            "description":"Key password(s). Valid only for type - X509 and category - IDENTITY"
        },
        "keystorePassword":{
            "type":"string",
            "description":"Keystore password. Valid only for type - X509 and category - IDENTITY"
        },
        "passPhrase":{
            "type":"string",
            "description":"Private key password. Valid only for type - PGP & SIGNKEY and category - PRIVATE"
        },
        "asciiArmored":{
            "type":"boolean",
            "description":"ASCII-Armor encryption flag. Valid only for type - PGP and category - PUBLIC"
        },
        "cipherAlgorithm":{
            "type":"string",
            "description":"Cipher algorithm. Valid only for type - PGP and category - PUBLIC"
        },
        "issued":{
            "type":"string",
            "description":"Certificate issued date",
            "format":"date-time"
        },
        "expires":{
            "type":"string",
            "description":"Certificate expiry date",
            "format":"date-time"
        },
        "status":{
            "type":"string",
            "description":"Certificate status. Ex. - CONFIGURED or INPROGRESS"
        },
        "createdBy":{
            "type":"string",
            "description":"Certificate created by"
        },
        "created":{
            "type":"string",
            "description":"Certificate created date",
            "format":"date-time"
        },
        "lastUpdatedBy":{
            "type":"string",
            "description":"Certificate updated by"
        },
        "lastUpdated":{
            "type":"string",
            "description":"Certificate updated date",
            "format":"date-time"
        },
        "metaData":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            }
        },
        "hash":{
            "type":"string"
        },
        "content":{
            "type":"array",
            "items":{
                "type":"string",
                "format":"byte"
            }
        },
        "secretOCID":{
            "type":"string"
        }
    }
}

ネストされたスキーマ: links

型: array

ソースを表示

Array of: object Link

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Link"
    }
}

ネストされたスキーマ: Link

型: object

ソースを表示

href: string
media-type: string
rel: string

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        },
        "media-type":{
            "type":"string"
        }
    }
}

ネストされたスキーマ : content

型: array

ソースを表示

Array of: string(byte)

{
    "type":"array",
    "items":{
        "type":"string",
        "format":"byte"
    }
}

ネストされたスキーマ : metaData

型: object

使用可能なその他のプロパティ

ソースを表示

string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    }
}

400レスポンス

パラメータの形式が正しくありません

500レスポンス

サーバー・エラー

トップに戻る

例

次の例は、cURLを使用してRESTリソースに対してGETリクエストを発行して、証明書の詳細を取得する方法を示しています。 cURLの詳細は、「cURLの使用」を参照してください。エンドポイントURLの構造の詳細は、「リクエストの送信」を参照してください。

例: PGPを含み、ステータスがCONFIGUREDの証明書を取得

curl -G -X GET -H 'Authorization: Bearer access_token' -H "Accept:application/json" --data-urlencode "q={name: /PGP/, status: 'CONFIGURED'}" https://design.integration.region.ocp.oraclecloud.com/ic/api/integration/v1/certificates?integrationInstance=service-instance

例: 返された証明書のページ区切り

ページ区切りは制限とオフセットで実行されます。この例では、4番目の項目から始まる証明書を一覧表示します。リストには16アイテムが含まれます。

curl -G -X GET -H 'Authorization: Bearer access_token' -H "Accept:application/json" -d "offset=3&limit=16" https://design.integration.region.ocp.oraclecloud.com/ic/api/integration/v1/certificates?integrationInstance=service-instance

例: 失効日順に並べられた証明書の取得

curl -G -X GET -H 'Authorization: Bearer access_token' -H "Accept:application/json" -d "orderBy=expiry" https://design.integration.region.ocp.oraclecloud.com/ic/api/integration/v1/certificates?integrationInstance=service-instance

例: すべての証明書を取得

curl -X GET -H 'Authorization: Bearer access_token' -H "Accept:application/json" https://design.integration.region.ocp.oraclecloud.com/ic/api/integration/v1/certificates?integrationInstance=service-instance

先頭に戻る