Oracle Enterprise ManagerのREST API

リストに指定されている名前付き資格証明のテスト

post

https://EM_HOST:EM_CONSOLE_HTTPS_PORT/em/api/namedCredentials/actions/bulkTest

インスタンス資格証明が資格証明のターゲットに対してテストされます。グローバル資格証明が指定されたターゲットに対してテストされます。

リクエスト

この操作にはリクエスト・パラメータはありません。

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

application/json

ルート・スキーマ: schema

型: object

これは、名前付き資格証明のテスト基準のリストで構成されます。

ソースの表示

testNamedCredentialRequests: array testNamedCredentialRequests

これは、名前付き資格証明のテスト基準のリストを表します

{
    "description":"This consists of list of Named Credential Test Criteria.",
    "type":"object",
    "properties":{
        "testNamedCredentialRequests":{
            "type":"array",
            "description":"This represents a list of Named Credential Test Criteria",
            "items":{
                "$ref":"#/components/schemas/TestCredentialCriteria"
            }
        }
    }
}

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

型: array

これは、名前付き資格証明のテスト基準のリストを表します

ソースの表示

配列: object TestCredentialCriteria

これは、名前付き資格証明をテストするために必要なデータで構成されます

{
    "type":"array",
    "description":"This represents a list of Named Credential Test Criteria",
    "items":{
        "$ref":"#/components/schemas/TestCredentialCriteria"
    }
}

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

型: object

これは、名前付き資格証明をテストするために必要なデータで構成されます

ソースの表示

authenticationTestTargetName: string

テスト・ターゲット名

例: testhost.example.com
authenticationTestTargetTypeName: string

テスト・ターゲット・タイプの名前

例: host
credentialNameAndOwnerCollection(必須): array credentialNameAndOwnerCollection

資格証明名リスト

{
    "description":"This consists of data required to test a named credential",
    "type":"object",
    "required":[
        "credentialNameAndOwnerCollection"
    ],
    "properties":{
        "authenticationTestTargetName":{
            "type":"string",
            "description":"Test target name",
            "example":"testhost.example.com"
        },
        "authenticationTestTargetTypeName":{
            "type":"string",
            "description":"Name of the test target type",
            "example":"host"
        },
        "credentialNameAndOwnerCollection":{
            "type":"array",
            "description":"Credential name list",
            "items":{
                "$ref":"#/components/schemas/CredentialNameAndOwnerCollection"
            }
        }
    }
}

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

型: array

資格証明名リスト

ソースの表示

配列: object CredentialNameAndOwnerCollection

テストする名前付き資格証明の資格証明名および所有者

{
    "type":"array",
    "description":"Credential name list",
    "items":{
        "$ref":"#/components/schemas/CredentialNameAndOwnerCollection"
    }
}

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

型: object

テストする名前付き資格証明の資格証明名および所有者

ソースの表示

credNames(必須): array credNames

特定の所有者の名前付き資格証明のリスト
credOwner: string

名前付き資格証明の所有者。指定しない場合、現在のログイン・ユーザーがデフォルトに設定されます

例: ADMIN1

{
    "description":"Credential name and owner for named credential to test",
    "type":"object",
    "required":[
        "credNames"
    ],
    "properties":{
        "credNames":{
            "type":"array",
            "description":"List of Named credentials for a particular owner",
            "items":{
                "type":"string",
                "example":"NAMEDCRED1, NAMEDCRED2"
            }
        },
        "credOwner":{
            "type":"string",
            "description":"Owner of named credential. If not provided it would default to current logged-in user",
            "example":"ADMIN1"
        }
    }
}

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

型: array

特定の所有者の名前付き資格証明のリスト

ソースの表示

配列: string

例: NAMEDCRED1, NAMEDCRED2

{
    "type":"array",
    "description":"List of Named credentials for a particular owner",
    "items":{
        "type":"string",
        "example":"NAMEDCRED1, NAMEDCRED2"
    }
}

例

先頭に戻る

レスポンス

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

application/json

200レスポンス

名前付き資格証明のテスト情報が正常に指定されました

ルート・スキーマ: NamedCredentialTestResultCollection

型: object

これは、名前付き資格証明についてテストされた様々なグローバル/ターゲット・インスタンスのリストを表します

ソースの表示

count: integer

名前付き資格証明についてテストされた様々なグローバル/ターゲット・インスタンスの数

例: 5
items: array items

これは、名前付き資格証明についてテストされた様々なグローバル/ターゲット・インスタンスのリストです

{
    "description":"This represents the list of different Global/Target instance tested over named credentials",
    "type":"object",
    "properties":{
        "count":{
            "type":"integer",
            "description":"The number of the different Global/Target instance tested over named credentials",
            "example":"5"
        },
        "items":{
            "type":"array",
            "description":"This is the list of different Global/Target instance tested over named credentials",
            "items":{
                "$ref":"#/components/schemas/NamedCredentialsTestResultsDetailsCollection"
            }
        }
    }
}

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

型: array

これは、名前付き資格証明についてテストされた様々なグローバル/ターゲット・インスタンスのリストです

ソースの表示

配列: object NamedCredentialsTestResultsDetailsCollection

これは、テストされた名前付き資格証明の結果データを表します

{
    "type":"array",
    "description":"This is the list of different Global/Target instance tested over named credentials",
    "items":{
        "$ref":"#/components/schemas/NamedCredentialsTestResultsDetailsCollection"
    }
}

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

型: object

これは、テストされた名前付き資格証明の結果データを表します

ソースの表示

authenticationTestTargetName: string

テスト・ターゲット名

例: server1.example.com
authenticationTestTargetTypeName: string

テスト・ターゲット・タイプの名前

例: host
count: integer

グローバル/ターゲット・インスタンス別にテストされた様々な名前付き資格証明のブロックの数

例: 10
namedCredentialsTestResponseCollection: array namedCredentialsTestResponseCollection

名前付き資格証明の名前とその結果のコレクション

{
    "description":"This represents the Result data of the named credentials tested",
    "type":"object",
    "properties":{
        "count":{
            "type":"integer",
            "description":"The number of the different named credentials blocks tested separated by global/target instance",
            "example":"10"
        },
        "authenticationTestTargetName":{
            "type":"string",
            "description":"Test target name",
            "example":"server1.example.com"
        },
        "authenticationTestTargetTypeName":{
            "type":"string",
            "description":"Name of the test target type",
            "example":"host"
        },
        "namedCredentialsTestResponseCollection":{
            "type":"array",
            "description":"Collection of Named credentials names and its results",
            "items":{
                "$ref":"#/components/schemas/NamedCredentialsTestResult"
            }
        }
    }
}

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

型: array

名前付き資格証明の名前とその結果のコレクション

ソースの表示

配列: object NamedCredentialsTestResult

これは、テストされた名前付き資格証明の結果データを表します

{
    "type":"array",
    "description":"Collection of Named credentials names and its results",
    "items":{
        "$ref":"#/components/schemas/NamedCredentialsTestResult"
    }
}

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

型: object

これは、テストされた名前付き資格証明の結果データを表します

ソースの表示

credentialName: string

名前付き資格証明の名前

例: NAMEDCRED1
errorMessage: string

名前付き資格証明のテストが失敗したときのエラー・メッセージ。

例: Authentication failure, check credential properties
isPassed: boolean

テストが成功した場合は、True。それ以外の場合は、False

例: true

{
    "description":"This represents the Result data of the named credentials tested",
    "type":"object",
    "properties":{
        "credentialName":{
            "type":"string",
            "description":"Name for a named credential",
            "example":"NAMEDCRED1"
        },
        "isPassed":{
            "type":"boolean",
            "description":"True if test was successful. False otherwise",
            "example":true
        },
        "errorMessage":{
            "type":"string",
            "description":"Error message when named credential test is unsuccessful.",
            "example":"Authentication failure, check credential properties"
        }
    }
}

例

400レスポンス

不正なリクエスト。ペイロードがnullであるか、一部のパラメータがありません

ルート・スキーマ: ErrorResponse

型: object

エラー・レスポンス

ソースの表示

code(必須): string

プログラムによる解析を目的とした、エラーを定義する短いエラー・コード。
message(必須): string

判読可能なエラー文字列

{
    "description":"Error response",
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error string",
            "type":"string"
        }
    }
}

401レスポンス

未認可。ユーザーにはリクエストされた操作を実行する権限がありません

ルート・スキーマ: ErrorResponse

型: object

エラー・レスポンス

ソースの表示

code(必須): string

プログラムによる解析を目的とした、エラーを定義する短いエラー・コード。
message(必須): string

判読可能なエラー文字列

{
    "description":"Error response",
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error string",
            "type":"string"
        }
    }
}

403レスポンス

禁止。ユーザーは、リクエストされた操作の実行を禁止されています

ルート・スキーマ: ErrorResponse

型: object

エラー・レスポンス

ソースの表示

code(必須): string

プログラムによる解析を目的とした、エラーを定義する短いエラー・コード。
message(必須): string

判読可能なエラー文字列

{
    "description":"Error response",
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error string",
            "type":"string"
        }
    }
}

404レスポンス

見つかりません。リクエストされたREST API URLが見つかりません。

ルート・スキーマ: ErrorResponse

型: object

エラー・レスポンス

ソースの表示

code(必須): string

プログラムによる解析を目的とした、エラーを定義する短いエラー・コード。
message(必須): string

判読可能なエラー文字列

{
    "description":"Error response",
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error string",
            "type":"string"
        }
    }
}

500レスポンス

内部サーバー・エラー。REST APIの実行中に例外が発生しました。

ルート・スキーマ: ErrorResponse

型: object

エラー・レスポンス

ソースの表示

code(必須): string

プログラムによる解析を目的とした、エラーを定義する短いエラー・コード。
message(必須): string

判読可能なエラー文字列

{
    "description":"Error response",
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error string",
            "type":"string"
        }
    }
}

先頭に戻る