Oracle Enterprise ManagerのREST API

名前付き資格証明のリスト

get

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

指定された基準でNamedCredentialのリストを提示します。デフォルトでは名前順(昇順)の結果の最初のページを返します。

リクエスト

問合せパラメータ

authenticatingTargetTypeName: string
名前付き資格証明の認証ターゲット・タイプの名前
例:
```
host
```
includeTotal: boolean
結果の合計数を返すかどうか。
例:
```
true
```
limit: integer
最小値: 1

最大値: 2000

フェッチされる名前付き資格証明の数

デフォルト値: 20
例:
```
20
```
name: string
資格証明名
例:
```
CREDNAME1
```
nameContains: string
フィルタ処理する資格証明名のパターン
例:
```
CREDNAM
```
owner: string
資格証明の所有者
例:
```
SYSMAN
```
page: string

self、nextおよびpreviousリンクにおいて使用されるシステム生成ページ・トークン。
scope: string
名前付き資格証明のスコープ(GLOBALまたはINSTANCEなど)
例:
```
GLOBAL
```
sort: string
方向付きの結果セットの順序。指定可能なソート・フィールドは、name、owner、targetTypeです。指定可能な方向はASCとDESCです。複数のフィールドをソートするには、field1:direction1,field2:direction2のようにカンマ区切りの値を指定します
例:
```
type:ASC,name:DESC
```
targetName: string
名前付き資格証明のターゲット名
例:
```
host.oracle.com
```
targetNameContains: string
フィルタ処理する名前付き資格証明のターゲット名
例:
```
myhostname
```
targetTypeName: string
名前付き資格証明のターゲット・タイプの名前
例:
```
host
```
targetUsername: string
ターゲットのユーザー名
例:
```
root
```
targetUsernameContains: string
フィルタ処理するターゲットのユーザー名
例:
```
SYS
```

この操作にはリクエスト本文はありません。

先頭に戻る

レスポンス

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

application/json

200レスポンス

名前付き資格証明のリストが正常に返されました

ルート・スキーマ: NamedCredentialCollection

型: object

これは、名前付き資格証明のリストを表すものです。

ソースの表示

count(必須): integer

このページ内の名前付き資格証明の数

例: 20
items(必須): array items

名前付き資格証明リスト
links(必須): object links

読取り専用: true

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

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

例: 101

{
    "description":"This is the representation of list of Named credentials.",
    "type":"object",
    "required":[
        "items",
        "links",
        "count"
    ],
    "properties":{
        "count":{
            "type":"integer",
            "description":"the number of Named 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?page=CURRENT_PAGE_TOKEN"
                            }
                        }
                    ]
                },
                "previous":{
                    "allOf":[
                        {
                            "$ref":"#/components/schemas/Link"
                        },
                        {
                            "example":{
                                "href":"/em/api/namedCredentials?page=PREVIOUS_PAGE_TOKEN"
                            }
                        }
                    ]
                },
                "next":{
                    "allOf":[
                        {
                            "$ref":"#/components/schemas/Link"
                        },
                        {
                            "example":{
                                "href":"/em/api/namedCredentials?page=NEXT_PAGE_TOKEN"
                            }
                        }
                    ]
                }
            }
        },
        "items":{
            "type":"array",
            "description":"the Named credentials list",
            "items":{
                "$ref":"#/components/schemas/NamedCredentialSummary"
            }
        }
    }
}

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

型: array

名前付き資格証明リスト

ソースの表示

配列: object NamedCredentialSummary

リストを返すために使用される名前付き資格証明の情報のスキーマ・オブジェクト

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

ネストされたスキーマ: 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?page=CURRENT_PAGE_TOKEN"
                    }
                }
            ]
        },
        "previous":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/Link"
                },
                {
                    "example":{
                        "href":"/em/api/namedCredentials?page=PREVIOUS_PAGE_TOKEN"
                    }
                }
            ]
        },
        "next":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/Link"
                },
                {
                    "example":{
                        "href":"/em/api/namedCredentials?page=NEXT_PAGE_TOKEN"
                    }
                }
            ]
        }
    }
}

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

型: object

リストを返すために使用される名前付き資格証明の情報のスキーマ・オブジェクト

ソースの表示

id: string

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

例: B0FBBE587FD201E2E0537013790A7D03
link: object link

名前付き資格証明関連リンク

{
    "type":"object",
    "description":"Schema object for Named Credential information used to return a list",
    "allOf":[
        {
            "$ref":"#/components/schemas/NamedCredentialCommon"
        }
    ],
    "properties":{
        "id":{
            "type":"string",
            "description":"Unique identifier for a named credential",
            "example":"B0FBBE587FD201E2E0537013790A7D03"
        },
        "link":{
            "type":"object",
            "description":"the named credential related link",
            "properties":{
                "self":{
                    "allOf":[
                        {
                            "$ref":"#/components/schemas/Link"
                        },
                        {
                            "description":"The link to the Named Credential"
                        },
                        {
                            "example":{
                                "href":"/em/api/namedCredentials/B0FBBE587FD201E2E0537013790A7D03"
                            }
                        }
                    ]
                }
            }
        }
    }
}

すべてに一致

ソースの表示

object NamedCredentialCommon

名前付き資格証明の共通プロパティ

{
    "type":"object",
    "description":"Schema object for Named Credential information used to return a list",
    "allOf":[
        {
            "$ref":"#/components/schemas/NamedCredentialCommon"
        }
    ],
    "properties":{
        "id":{
            "type":"string",
            "description":"Unique identifier for a named credential",
            "example":"B0FBBE587FD201E2E0537013790A7D03"
        },
        "link":{
            "type":"object",
            "description":"the named credential related link",
            "properties":{
                "self":{
                    "allOf":[
                        {
                            "$ref":"#/components/schemas/Link"
                        },
                        {
                            "description":"The link to the Named Credential"
                        },
                        {
                            "example":{
                                "href":"/em/api/namedCredentials/B0FBBE587FD201E2E0537013790A7D03"
                            }
                        }
                    ]
                }
            }
        }
    }
}

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

型: object

名前付き資格証明関連リンク

ソースの表示

self: self

{
    "type":"object",
    "description":"the named credential related link",
    "properties":{
        "self":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/Link"
                },
                {
                    "description":"The link to the Named Credential"
                },
                {
                    "example":{
                        "href":"/em/api/namedCredentials/B0FBBE587FD201E2E0537013790A7D03"
                    }
                }
            ]
        }
    }
}

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

型: object

名前付き資格証明の共通プロパティ

ソースの表示

authenticatingTargetTypeName(必須): string

名前付き資格証明の認証ターゲット・タイプの名前

例: host
description: string

名前付き資格証明の説明

例: Named credential for SYSMAN user hosts
name(必須): string

名前付き資格証明の名前

例: NAMEDCRED1
owner: string

名前付き資格証明のユーザー所有者

例: SYSMAN
scope(必須): string

名前付き資格証明のスコープ

例: INSTANCE
targetName: string

名前付き資格証明が認証されるターゲット・インスタンス名

例: host.us.oracle.com
targetTypeName: string

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

例: host
targetUsername: string

ターゲットのユーザー名

例: root
type(必須): string

名前付き資格証明のタイプ

例: HostCreds

{
    "type":"object",
    "required":[
        "name",
        "authenticatingTargetTypeName",
        "type",
        "scope"
    ],
    "description":"Common properties for a Named Credential",
    "properties":{
        "name":{
            "type":"string",
            "description":"Name for a named credential",
            "example":"NAMEDCRED1"
        },
        "description":{
            "type":"string",
            "description":"Description for a named credential",
            "example":"Named credential for SYSMAN user hosts"
        },
        "owner":{
            "type":"string",
            "description":"User owner of the named credential",
            "example":"SYSMAN"
        },
        "authenticatingTargetTypeName":{
            "type":"string",
            "description":"Name of the Authenticating target type of the named credential",
            "example":"host"
        },
        "type":{
            "type":"string",
            "description":"Named Credential type",
            "example":"HostCreds"
        },
        "scope":{
            "type":"string",
            "description":"Named credential scope",
            "example":"INSTANCE",
            "items":{
                "$ref":"#/components/schemas/NamedCredentialScope"
            }
        },
        "targetTypeName":{
            "type":"string",
            "description":"Name of the target type",
            "example":"host"
        },
        "targetName":{
            "type":"string",
            "description":"Target instance name for which named credential is authenticated to",
            "example":"host.us.oracle.com"
        },
        "targetUsername":{
            "type":"string",
            "description":"Username of the target",
            "example":"root"
        }
    }
}

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

すべてに一致

ソースの表示

object Link

リンクを表します(self、previous、nextのいずれか)
名前付き資格証明へのリンク
例: { "href":"/em/api/namedCredentials/B0FBBE587FD201E2E0537013790A7D03" }

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Link"
        },
        {
            "description":"The link to the Named Credential"
        },
        {
            "example":{
                "href":"/em/api/namedCredentials/B0FBBE587FD201E2E0537013790A7D03"
            }
        }
    ]
}

ネストされたスキーマ: 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/namedCredentials?page=NEXT_PAGE_TOKEN" }

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

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

すべてに一致

ソースの表示

object Link

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

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

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

すべてに一致

ソースの表示

object Link

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

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

例

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

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

先頭に戻る