名前付き資格証明を優先資格証明として設定
post
https://EM_HOST:EM_CONSOLE_HTTPS_PORT/em/api/namedCredentials/actions/setPreferredCredential
ターゲット・タイプ/ターゲット・インスタンスの優先として既存の名前付き資格証明を設定し、ペイロードで指定された名前を設定します。
リクエスト
この操作にはリクエスト・パラメータはありません。
サポートされているメディア・タイプ
- application/json
ルート・スキーマ: schema
型:
object
setPreferredCredentialアクションに必要な優先資格証明データを保持するスキーマ・オブジェクト。優先として設定する名前付き資格証明を検索するために、credGuidを渡すか、credNameとcredOwnerの組合せを渡すことができます。
ソースの表示
-
authenticationTargetType: string
認証ターゲット・タイプ。デフォルトはtargetTypeNameです例:
host
-
credGuid: string
名前付き資格証明の一意の識別子例:
B0FBBE587FD201E2E0537013790A7D03
-
credName: string
名前付き資格証明の名前例:
NAMEDCRED1
-
credOwner: string
名前付き資格証明のユーザー所有者例:
SYSMAN
-
forUser: string
優先資格証明が設定されているユーザー例:
SYSMAN
-
isAuthenticationRequired: boolean
資格証明の保存前に認証が必要な場合はtrue例:
false
すべてに一致
ソースの表示
- object 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
例
先頭に戻る
レスポンス
サポートされているメディア・タイプ
- application/json
200レスポンス
優先資格証明が正常に設定されました
ルート・スキーマ: PreferredCredential
型:
object
検索アクションから返された優先資格証明データを保持するスキーマ・オブジェクト
ソースの表示
-
credGuid: string
名前付き資格証明の一意の識別子例:
B0FBBE587FD201E2E0537013790A7D03
-
isCredSetConfigured: boolean
指定されたケースに優先資格証明が構成され、NCへのリンクが使用可能な場合、有効な値が存在し、falseとして構成されていないセットでNCリンクが使用可能な場合はtrue。優先がまったく設定されていない場合はfalseで、NCへのリンクはありません。例:
false
-
links: object links
読取り専用:
true
優先資格証明に関連付けられた資格証明名およびターゲット・リンク -
targetTypeGuid: string
ターゲット・タイプの一意の識別子例:
DD395385F69A25570431A719EEA45030
すべてに一致
ソースの表示
- object 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
ネストされたスキーマ: Link
型:
object
リンクを表します(self、previous、nextのいずれか)
ソースの表示
-
href: string
リンクのためのURL例:
/em/api/<resources>?page=b2Zmc2V0OjA&limit=0
400レスポンス
不正なリクエスト。ペイロードがnullであるか、一部のパラメータがありません
ルート・スキーマ: ErrorResponse
型:
object
エラー・レスポンス
ソースの表示
-
code(必須): string
プログラムによる解析を目的とした、エラーを定義する短いエラー・コード。
-
message(必須): string
判読可能なエラー文字列
401レスポンス
未認可。ユーザーにはリクエストされた操作を実行する権限がありません
ルート・スキーマ: ErrorResponse
型:
object
エラー・レスポンス
ソースの表示
-
code(必須): string
プログラムによる解析を目的とした、エラーを定義する短いエラー・コード。
-
message(必須): string
判読可能なエラー文字列
403レスポンス
禁止。ユーザーは、リクエストされた操作の実行を禁止されています
ルート・スキーマ: ErrorResponse
型:
object
エラー・レスポンス
ソースの表示
-
code(必須): string
プログラムによる解析を目的とした、エラーを定義する短いエラー・コード。
-
message(必須): string
判読可能なエラー文字列
409レスポンス
競合
ルート・スキーマ: ErrorResponse
型:
object
エラー・レスポンス
ソースの表示
-
code(必須): string
プログラムによる解析を目的とした、エラーを定義する短いエラー・コード。
-
message(必須): string
判読可能なエラー文字列
500レスポンス
内部サーバー・エラー。REST APIの実行中に例外が発生しました。
ルート・スキーマ: ErrorResponse
型:
object
エラー・レスポンス
ソースの表示
-
code(必須): string
プログラムによる解析を目的とした、エラーを定義する短いエラー・コード。
-
message(必須): string
判読可能なエラー文字列
503レスポンス
サービスが使用できません。サーバーはリクエストを処理できません。
ルート・スキーマ: ErrorResponse
型:
object
エラー・レスポンス
ソースの表示
-
code(必須): string
プログラムによる解析を目的とした、エラーを定義する短いエラー・コード。
-
message(必須): string
判読可能なエラー文字列