Oracle Enterprise ManagerのREST API

名前付き資格証明を優先資格証明として設定

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

{
    "type":"object",
    "description":"Schema object to hold Preferred Credential data required in the setPreferredCredential action. credGuid can be passed or credName and credOwner combination in order to find the named credential to set as preferred.",
    "allOf":[
        {
            "$ref":"#/components/schemas/PreferredCredentialCommon"
        }
    ],
    "properties":{
        "credName":{
            "type":"string",
            "description":"Name for a named credential",
            "example":"NAMEDCRED1"
        },
        "credOwner":{
            "type":"string",
            "description":"User owner of the named credential",
            "example":"SYSMAN"
        },
        "credGuid":{
            "type":"string",
            "description":"Unique identifier for a named credential",
            "example":"B0FBBE587FD201E2E0537013790A7D03"
        },
        "forUser":{
            "type":"string",
            "description":"User for which preferred credential is being set",
            "example":"SYSMAN"
        },
        "isAuthenticationRequired":{
            "type":"boolean",
            "description":"true if authentication is required before saving credential",
            "example":false
        },
        "authenticationTargetType":{
            "type":"string",
            "description":"The authenticating target type. Defaults to targetTypeName",
            "example":"host"
        }
    }
}

すべてに一致

ソースの表示

object PreferredCredentialCommon

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

{
    "type":"object",
    "description":"Schema object to hold Preferred Credential data required in the setPreferredCredential action. credGuid can be passed or credName and credOwner combination in order to find the named credential to set as preferred.",
    "allOf":[
        {
            "$ref":"#/components/schemas/PreferredCredentialCommon"
        }
    ],
    "properties":{
        "credName":{
            "type":"string",
            "description":"Name for a named credential",
            "example":"NAMEDCRED1"
        },
        "credOwner":{
            "type":"string",
            "description":"User owner of the named credential",
            "example":"SYSMAN"
        },
        "credGuid":{
            "type":"string",
            "description":"Unique identifier for a named credential",
            "example":"B0FBBE587FD201E2E0537013790A7D03"
        },
        "forUser":{
            "type":"string",
            "description":"User for which preferred credential is being set",
            "example":"SYSMAN"
        },
        "isAuthenticationRequired":{
            "type":"boolean",
            "description":"true if authentication is required before saving credential",
            "example":false
        },
        "authenticationTargetType":{
            "type":"string",
            "description":"The authenticating target type. Defaults to targetTypeName",
            "example":"host"
        }
    }
}

ネストされたスキーマ: 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"
        }
    }
}

例

先頭に戻る

レスポンス

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

application/json

200レスポンス

優先資格証明が正常に設定されました

ルート・スキーマ: PreferredCredential

型: object

検索アクションから返された優先資格証明データを保持するスキーマ・オブジェクト

ソースの表示

credGuid: string

名前付き資格証明の一意の識別子

例: B0FBBE587FD201E2E0537013790A7D03
isCredSetConfigured: boolean

指定されたケースに優先資格証明が構成され、NCへのリンクが使用可能な場合、有効な値が存在し、falseとして構成されていないセットでNCリンクが使用可能な場合はtrue。優先がまったく設定されていない場合はfalseで、NCへのリンクはありません。

例: false
links: object links

読取り専用: true

優先資格証明に関連付けられた資格証明名およびターゲット・リンク
targetTypeGuid: string

ターゲット・タイプの一意の識別子

例: DD395385F69A25570431A719EEA45030

{
    "type":"object",
    "description":"Schema object to hold Preferred Credential data returned from the search action",
    "allOf":[
        {
            "$ref":"#/components/schemas/PreferredCredentialCommon"
        }
    ],
    "properties":{
        "isCredSetConfigured":{
            "type":"boolean",
            "description":"true when preferred credential is configured for given case and link to NC is available. when effective value is there and not configured set as false but NC link is available. If no Preferred set at all then false and no link to NC.",
            "example":false
        },
        "credGuid":{
            "type":"string",
            "description":"Unique identifier for a named credential",
            "example":"B0FBBE587FD201E2E0537013790A7D03"
        },
        "targetTypeGuid":{
            "type":"string",
            "description":"Unique identifier for target type",
            "example":"DD395385F69A25570431A719EEA45030"
        },
        "links":{
            "type":"object",
            "readOnly":true,
            "description":"the credential name and target links associated to the preferred credentials",
            "properties":{
                "namedCredential":{
                    "allOf":[
                        {
                            "$ref":"#/components/schemas/Link"
                        },
                        {
                            "example":{
                                "href":"/em/api/namedCredentials/B0FBBE587FD201E2E0537013790A7D01"
                            }
                        }
                    ]
                },
                "target":{
                    "allOf":[
                        {
                            "$ref":"#/components/schemas/Link"
                        },
                        {
                            "example":{
                                "href":"/em/api/targets/C0FCDE587FD201E2E0537013790A7D45"
                            }
                        }
                    ]
                },
                "credentialSet":{
                    "allOf":[
                        {
                            "$ref":"#/components/schemas/Link"
                        },
                        {
                            "example":{
                                "href":"/em/api/targetTypes/host/credentialSets/HostNormalCreds"
                            }
                        }
                    ]
                }
            }
        }
    }
}

すべてに一致

ソースの表示

object PreferredCredentialCommon

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

{
    "type":"object",
    "description":"Schema object to hold Preferred Credential data returned from the search action",
    "allOf":[
        {
            "$ref":"#/components/schemas/PreferredCredentialCommon"
        }
    ],
    "properties":{
        "isCredSetConfigured":{
            "type":"boolean",
            "description":"true when preferred credential is configured for given case and link to NC is available. when effective value is there and not configured set as false but NC link is available. If no Preferred set at all then false and no link to NC.",
            "example":false
        },
        "credGuid":{
            "type":"string",
            "description":"Unique identifier for a named credential",
            "example":"B0FBBE587FD201E2E0537013790A7D03"
        },
        "targetTypeGuid":{
            "type":"string",
            "description":"Unique identifier for target type",
            "example":"DD395385F69A25570431A719EEA45030"
        },
        "links":{
            "type":"object",
            "readOnly":true,
            "description":"the credential name and target links associated to the preferred credentials",
            "properties":{
                "namedCredential":{
                    "allOf":[
                        {
                            "$ref":"#/components/schemas/Link"
                        },
                        {
                            "example":{
                                "href":"/em/api/namedCredentials/B0FBBE587FD201E2E0537013790A7D01"
                            }
                        }
                    ]
                },
                "target":{
                    "allOf":[
                        {
                            "$ref":"#/components/schemas/Link"
                        },
                        {
                            "example":{
                                "href":"/em/api/targets/C0FCDE587FD201E2E0537013790A7D45"
                            }
                        }
                    ]
                },
                "credentialSet":{
                    "allOf":[
                        {
                            "$ref":"#/components/schemas/Link"
                        },
                        {
                            "example":{
                                "href":"/em/api/targetTypes/host/credentialSets/HostNormalCreds"
                            }
                        }
                    ]
                }
            }
        }
    }
}

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

型: object

読取り専用: true

優先資格証明に関連付けられた資格証明名およびターゲット・リンク

ソースの表示

credentialSet: credentialSet
namedCredential: namedCredential
target: target

{
    "type":"object",
    "readOnly":true,
    "description":"the credential name and target links associated to the preferred credentials",
    "properties":{
        "namedCredential":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/Link"
                },
                {
                    "example":{
                        "href":"/em/api/namedCredentials/B0FBBE587FD201E2E0537013790A7D01"
                    }
                }
            ]
        },
        "target":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/Link"
                },
                {
                    "example":{
                        "href":"/em/api/targets/C0FCDE587FD201E2E0537013790A7D45"
                    }
                }
            ]
        },
        "credentialSet":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/Link"
                },
                {
                    "example":{
                        "href":"/em/api/targetTypes/host/credentialSets/HostNormalCreds"
                    }
                }
            ]
        }
    }
}

ネストされたスキーマ: 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"
        }
    }
}

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

すべてに一致

ソースの表示

object Link

リンクを表します(self、previous、nextのいずれか)
例: { "href":"/em/api/targetTypes/host/credentialSets/HostNormalCreds" }

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Link"
        },
        {
            "example":{
                "href":"/em/api/targetTypes/host/credentialSets/HostNormalCreds"
            }
        }
    ]
}

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

すべてに一致

ソースの表示

object Link

リンクを表します(self、previous、nextのいずれか)
例: { "href":"/em/api/namedCredentials/B0FBBE587FD201E2E0537013790A7D01" }

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Link"
        },
        {
            "example":{
                "href":"/em/api/namedCredentials/B0FBBE587FD201E2E0537013790A7D01"
            }
        }
    ]
}

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

すべてに一致

ソースの表示

object Link

リンクを表します(self、previous、nextのいずれか)
例: { "href":"/em/api/targets/C0FCDE587FD201E2E0537013790A7D45" }

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Link"
        },
        {
            "example":{
                "href":"/em/api/targets/C0FCDE587FD201E2E0537013790A7D45"
            }
        }
    ]
}

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

型: object

リンクを表します(self、previous、nextのいずれか)

ソースの表示

href: string

リンクのためのURL

例: /em/api/<resources>?page=b2Zmc2V0OjA&limit=0

{
    "type":"object",
    "description":"Represents a link(could be self, previous or next)",
    "properties":{
        "href":{
            "type":"string",
            "description":"URL for Link",
            "example":"/em/api/<resources>?page=b2Zmc2V0OjA&limit=0"
        }
    }
}

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

409レスポンス

競合

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

先頭に戻る