Oracle Enterprise ManagerのREST API

優先資格証明の検索

post

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

リクエスト・ペイロードで提供されるフィルタに基づいて、一致する優先資格証明を検索します。

リクエスト

問合せパラメータ

includeTotal: boolean
結果の合計数を返すかどうか。
例:
```
true
```
limit: integer
最小値: 1

最大値: 2000

フェッチされる優先資格証明の数

デフォルト値: 20
例:
```
20
```
page: string

self、nextおよびpreviousリンクにおいて使用されるシステム生成ページ・トークン。
sort: string
方向付きの結果セットの順序。使用可能なソート・フィールドは、targetName、setName、targetTypeName、isDefault、isGlobal、isCredSetConfiguredです。指定可能な方向はASCとDESCです。複数のフィールドをソートするには、field1:direction1,field2:direction2のようにカンマ区切りの値を指定します
例:
```
type:ASC,name:DESC
```

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

application/json

ルート・スキーマ: schema

型: object

優先資格証明の検索ペイロードを保持するスキーマ・オブジェクト

ソースの表示

isDefault: boolean

優先資格証明がターゲット・タイプ・レベルの場合はtrueで、ターゲット・インスタンス・レベルの場合はfalse

例: false
isGlobal: boolean

デフォルト値: false

優先資格証明がグローバル・スコープの場合はtrueで、ユーザー・スコープの場合はfalse。

例: true
setName: array setName

資格証明セット名
setNameContains: array setNameContains

フィルタ処理する優先資格証明セット名のパターン。大/小文字が区別されます。
targetName: array targetName

優先資格証明のターゲット名
targetNameContains: array targetNameContains

フィルタ処理する優先資格証明のターゲット名
targetTypeName(必須): array targetTypeName

優先資格証明のtargetType

{
    "type":"object",
    "description":"Schema object to hold preferred credential search payload",
    "required":[
        "targetTypeName"
    ],
    "properties":{
        "targetNameContains":{
            "type":"array",
            "description":"target name of the preferred credential to be filtered",
            "items":{
                "type":"string",
                "example":[
                    "myhostname1",
                    "myhostname2"
                ]
            }
        },
        "setNameContains":{
            "type":"array",
            "description":"Preferred credential set name pattern to be filtered. Case sensitive.",
            "items":{
                "type":"string",
                "example":[
                    "set1",
                    "set2"
                ]
            }
        },
        "setName":{
            "type":"array",
            "description":"credential set name",
            "items":{
                "type":"string",
                "example":[
                    "CREDSET1",
                    "CREDSET2"
                ]
            }
        },
        "targetName":{
            "type":"array",
            "description":"target name of preferred credential",
            "items":{
                "type":"string",
                "example":[
                    "www.myhost.com1",
                    "www.myhost.com2"
                ]
            }
        },
        "targetTypeName":{
            "type":"array",
            "description":"targetType of preferred credential",
            "items":{
                "type":"string",
                "example":[
                    "host1",
                    "host2"
                ]
            }
        },
        "isGlobal":{
            "type":"boolean",
            "description":"true when preferred credential is global scope. false when it is User scope.",
            "default":false,
            "example":true
        },
        "isDefault":{
            "type":"boolean",
            "description":"true when preferred credential is target type level. false when it is target instance level",
            "example":false
        }
    }
}

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

型: array

資格証明セット名

ソースの表示

配列: string

例: [ "CREDSET1", "CREDSET2" ]

{
    "type":"array",
    "description":"credential set name",
    "items":{
        "type":"string",
        "example":[
            "CREDSET1",
            "CREDSET2"
        ]
    }
}

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

型: array

フィルタ処理する優先資格証明セット名のパターン。大/小文字が区別されます。

ソースの表示

配列: string

例: [ "set1", "set2" ]

{
    "type":"array",
    "description":"Preferred credential set name pattern to be filtered. Case sensitive.",
    "items":{
        "type":"string",
        "example":[
            "set1",
            "set2"
        ]
    }
}

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

型: array

優先資格証明のターゲット名

ソースの表示

配列: string

例: [ "www.myhost.com1", "www.myhost.com2" ]

{
    "type":"array",
    "description":"target name of preferred credential",
    "items":{
        "type":"string",
        "example":[
            "www.myhost.com1",
            "www.myhost.com2"
        ]
    }
}

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

型: array

フィルタ処理する優先資格証明のターゲット名

ソースの表示

配列: string

例: [ "myhostname1", "myhostname2" ]

{
    "type":"array",
    "description":"target name of the preferred credential to be filtered",
    "items":{
        "type":"string",
        "example":[
            "myhostname1",
            "myhostname2"
        ]
    }
}

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

型: array

優先資格証明のtargetType

ソースの表示

配列: string

例: [ "host1", "host2" ]

{
    "type":"array",
    "description":"targetType of preferred credential",
    "items":{
        "type":"string",
        "example":[
            "host1",
            "host2"
        ]
    }
}

例

先頭に戻る

レスポンス

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

application/json

200レスポンス

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

ルート・スキーマ: PreferredCredentialCollection

型: object

これは、優先資格証明のリストを表すものです。

ソースの表示

count(必須): integer

このページ内の優先資格証明の数

例: 20
items(必須): array items

優先資格証明リスト
links(必須): object links

読取り専用: true

結果セットのナビゲーション・リンク
total: integer

使用可能なアイテムの合計数(全ページ)

例: 101

{
    "description":"This is the representation of list of preferred credentials.",
    "type":"object",
    "required":[
        "items",
        "links",
        "count"
    ],
    "properties":{
        "count":{
            "type":"integer",
            "description":"the number of Preferred credentials in this page",
            "example":"20"
        },
        "total":{
            "type":"integer",
            "description":"Total number of items that are available (for all the pages)",
            "example":"101"
        },
        "links":{
            "type":"object",
            "readOnly":true,
            "description":"the result set navigation links",
            "properties":{
                "self":{
                    "allOf":[
                        {
                            "$ref":"#/components/schemas/Link"
                        },
                        {
                            "example":{
                                "href":"/em/api/namedCredentials/actions/searchPreferredCredential?page={CURRENT_PAGE_TOKEN}"
                            }
                        }
                    ]
                },
                "previous":{
                    "allOf":[
                        {
                            "$ref":"#/components/schemas/Link"
                        },
                        {
                            "example":{
                                "href":"/em/api/actions/searchPreferredCredential?page={PREVIOUS_PAGE_TOKEN}"
                            }
                        }
                    ]
                },
                "next":{
                    "allOf":[
                        {
                            "$ref":"#/components/schemas/Link"
                        },
                        {
                            "example":{
                                "href":"/em/api/actions/searchPreferredCredential?page={NEXT_PAGE_TOKEN}"
                            }
                        }
                    ]
                }
            }
        },
        "items":{
            "type":"array",
            "description":"the Preferred credentials list",
            "items":{
                "$ref":"#/components/schemas/PreferredCredential"
            }
        }
    }
}

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

型: array

優先資格証明リスト

ソースの表示

配列: object PreferredCredential

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

{
    "type":"array",
    "description":"the Preferred credentials list",
    "items":{
        "$ref":"#/components/schemas/PreferredCredential"
    }
}

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

型: object

読取り専用: true

結果セットのナビゲーション・リンク

ソースの表示

next: next
previous: previous
self: self

{
    "type":"object",
    "readOnly":true,
    "description":"the result set navigation links",
    "properties":{
        "self":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/Link"
                },
                {
                    "example":{
                        "href":"/em/api/namedCredentials/actions/searchPreferredCredential?page={CURRENT_PAGE_TOKEN}"
                    }
                }
            ]
        },
        "previous":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/Link"
                },
                {
                    "example":{
                        "href":"/em/api/actions/searchPreferredCredential?page={PREVIOUS_PAGE_TOKEN}"
                    }
                }
            ]
        },
        "next":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/Link"
                },
                {
                    "example":{
                        "href":"/em/api/actions/searchPreferredCredential?page={NEXT_PAGE_TOKEN}"
                    }
                }
            ]
        }
    }
}

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

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

すべてに一致

ソースの表示

object Link

リンクを表します(self、previous、nextのいずれか)
例: { "href":"/em/api/actions/searchPreferredCredential?page={NEXT_PAGE_TOKEN}" }

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Link"
        },
        {
            "example":{
                "href":"/em/api/actions/searchPreferredCredential?page={NEXT_PAGE_TOKEN}"
            }
        }
    ]
}

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

すべてに一致

ソースの表示

object Link

リンクを表します(self、previous、nextのいずれか)
例: { "href":"/em/api/actions/searchPreferredCredential?page={PREVIOUS_PAGE_TOKEN}" }

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Link"
        },
        {
            "example":{
                "href":"/em/api/actions/searchPreferredCredential?page={PREVIOUS_PAGE_TOKEN}"
            }
        }
    ]
}

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

すべてに一致

ソースの表示

object Link

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

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Link"
        },
        {
            "example":{
                "href":"/em/api/namedCredentials/actions/searchPreferredCredential?page={CURRENT_PAGE_TOKEN}"
            }
        }
    ]
}

先頭に戻る