ジャンプ先

• リクエスト
• レスポンス
• 例

キー・ペアまたはキー・ペアのリストの取得

get

/oam/services/rest/ssa/api/v1/keypairadmin/keypair

別名別のキー・ペア、失効までの日数別のキー・ペア、またはすべてのキー・ペアを返します

リクエスト

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

• application/json
• application/x-www-form-urlencoded

問合せパラメータ

• aliasName(optional): string
  取得されるキー・ペアの別名。
• expiryDays(optional): string
  指定した日数以内に失効するキー・ペアまたはキー・ペアのリストを取得します。

先頭に戻る

レスポンス

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

• text/plain
• application/json

200 レスポンス

本文()

ルート・スキーマ: KeyPairArtifacts

型: array

ソースを表示

• 配列: オブジェクト KeyPairArtifactObject
  キー・ペア・アーティファクトの詳細

{
    "type":"array",
    "xml":{
        "name":"KeyPairArtifacts",
        "wrapped":true
    },
    "items":{
        "$ref":"#/definitions/KeyPairArtifactObject"
    }
}

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

型: object

キー・ペア・アーティファクトの詳細

ソースを表示

• aliasName(optional): string
  キー・ペアの別名
• domains(optional): string
  現在、キー・ペアを使用しているOAuthアイデンティティ・ドメイン
• expiry(optional): string
  キー・ペアの有効期限日
• issuedOn(optional): string
  キー・ペアの発行日
• issuer(optional): string
  キー・ペアの発行者の名前
• publicKeyDetails(optional): string
  キー・ペアの追加詳細
• subjectDN(optional): string
  キー・ペアのサブジェクトDN

{
    "type":"object",
    "description":"KeyPair artifact details",
    "properties":{
        "aliasName":{
            "type":"string",
            "description":"Alias Name of the KeyPair"
        },
        "subjectDN":{
            "type":"string",
            "description":"subjectDN of the KeyPair"
        },
        "issuer":{
            "type":"string",
            "description":"Name of the issuer of the KeyPair"
        },
        "expiry":{
            "type":"string",
            "description":"Expiry date of the KeyPair"
        },
        "issuedOn":{
            "type":"string",
            "description":"Date of issuance of the KeyPair"
        },
        "publicKeyDetails":{
            "type":"string",
            "description":"Additional details of the KeyPair"
        },
        "domains":{
            "type":"string",
            "description":"OAuth Identity Domains that are currently making use of the KeyPair"
        }
    }
}

400 レスポンス

NameOfKeyPairの取得に失敗しました。キー・ペアのフェッチ中に例外が発生しました。NameOfKeyPair例外: NameOfKeyPairが見つかりません

先頭に戻る

例

cURLサンプル・リクエスト1

curl--location--request GET 'https://<admin-host>:<admin-port>/oam/services/rest/ssa/api/v1/keypairadmin/keypair?aliasName=NewDomain' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic dGVzdDp0ZXN0='

cURLサンプル・レスポンス1

[
    {
        "aliasName": "NewDomain",
        "subjectDN": "CN=BadSSL Client Certificate, O=BadSSL, L=San Francisco, ST=California, C=US",
        "issuer": "CN=BadSSL Client Root Certificate Authority, O=BadSSL, L=San Francisco, ST=California, C=US",
        "expiry": "Thu Nov 25 16:19:57 PST 2021",
        "issuedOn": "Tue Nov 26 16:19:57 PST 2019",
        "publicKeyDetails": "Sun RSA public key, 2048 bits",
        "domains": ""
    }
]

cURLサンプル・リクエスト2

curl --location --request GET 'https://<admin-host>:<admin-port>/oam/services/rest/ssa/api/v1/keypairadmin/keypair' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic dGVzdDp0ZXN0='

cURLサンプル・レスポンス2

[
    {
        "aliasName": "NewDomain1",
        "subjectDN": "EMAILADDRESS=[e-mail], CN=testbox.acme.com, OU=TEST CA, O=acme GmbH, L=Munich, ST=Bavaria, C=DE",
        "issuer": "EMAILADDRESS=[e-mail], CN=x.acme.com, OU=DEMO-CA, O=acme GmbH, L=Munich, ST=Bavaria, C=DE",
        "expiry": "Fri Oct 21 04:08:42 PDT 2022",
        "issuedOn": "Sun Oct 22 04:08:42 PDT 2017",
        "publicKeyDetails": "Sun RSA public key, 2048 bits",
        "domains": ""
    },
    {
        "aliasName": "NewDomain",
        "subjectDN": "CN=BadSSL Client Certificate, O=BadSSL, L=San Francisco, ST=California, C=US",
        "issuer": "CN=BadSSL Client Root Certificate Authority, O=BadSSL, L=San Francisco, ST=California, C=US",
        "expiry": "Thu Nov 25 16:19:57 PST 2021",
        "issuedOn": "Tue Nov 26 16:19:57 PST 2019",
        "publicKeyDetails": "Sun RSA public key, 2048 bits",
        "domains": "ID1"
    }
]

先頭に戻る