移動先

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

ターゲットに対する優先資格証明のテスト

post

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

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

リクエスト

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

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

• application/json

リクエスト本文 - application/json ()

ルート・スキーマ: schema

型: object

テスト・アクションの優先資格証明詳細を保持するスキーマ・オブジェクト。targetGuidが渡されない場合、targetNameおよびtargetTypeNameが必要です

すべてに一致

ソースの表示

• object PreferredCredentialCommon
  優先資格証明データを保持する共通スキーマ・オブジェクト

{
    "type":"object",
    "description":"Schema object to hold Preferred Credential details for test action. When targetGuid is not passed, targetName and targetTypeName are required",
    "required":[
        "setName",
        "isGlobal",
        "isDefault"
    ],
    "allOf":[
        {
            "$ref":"#/components/schemas/PreferredCredentialCommon"
        }
    ]
}

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

型: object

優先資格証明データを保持する共通スキーマ・オブジェクト

ソースの表示

• isDefault(必須): boolean
  優先資格証明がターゲット・タイプ・レベルの場合はtrueで、ターゲット・インスタンス・レベルの場合はfalse

  例: false
• isGlobal(必須): boolean
  優先資格証明がグローバル・スコープの場合はtrueで、ユーザー・スコープの場合はfalse。

  例: true
• setName(必須): string
  資格証明セットの名前

  例: HostCredsNormal
• targetGuid: string
  優先資格証明のターゲット・インスタンスID。

  例: A3CDDE587FD221E2F3539013290B7F05
• targetName: string
  名前付き資格証明が認証されるターゲット・インスタンス名

  例: host.us.oracle.com
• targetTypeName: string
  ターゲット・タイプの名前

  例: host

{
    "type":"object",
    "required":[
        "setName",
        "isGlobal",
        "isDefault"
    ],
    "description":"Common schema object to hold Preferred Credential data",
    "properties":{
        "targetTypeName":{
            "type":"string",
            "description":"Name of the target type",
            "example":"host"
        },
        "setName":{
            "type":"string",
            "description":"Name for a credential set",
            "example":"HostCredsNormal"
        },
        "isGlobal":{
            "type":"boolean",
            "description":"true when preferred credential is global scope. false when it is User scope.",
            "example":true
        },
        "isDefault":{
            "type":"boolean",
            "description":"true when preferred credential is target type level. false when it is target instance level",
            "example":false
        },
        "targetName":{
            "type":"string",
            "description":"Target instance name for which named credential is authenticated to",
            "example":"host.us.oracle.com"
        },
        "targetGuid":{
            "type":"string",
            "description":"Target instance id of a preferred credential.",
            "example":"A3CDDE587FD221E2F3539013290B7F05"
        }
    }
}

例

例の選択 リクエスト・ペイロード1 リクエスト・ペイロード2

先頭に戻る

レスポンス

204レスポンス

優先資格証明が正常にテストされました

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"
        }
    }
}

503レスポンス

サービスが使用できません。サーバーはリクエストを処理できません。

本文()

ルート・スキーマ: 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"
        }
    }
}

先頭に戻る