REST API for Oracle Enterprise Manager

List named credentials

get

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

Gives list of NamedCredential with a given criteria. Returns the first page of results ordered by name (ascending) by default.

Request

Query Parameters

authenticatingTargetTypeName: string
Name of the Authenticating target type of the named credential
Example:
```
host
```
includeTotal: boolean
whether total number of results shall be returned.
Example:
```
true
```
limit: integer
Minimum Value: 1

Maximum Value: 2000

Number of Named credentials to be fetched

Default Value: 20
Example:
```
20
```
name: string
Credential name
Example:
```
CREDNAME1
```
nameContains: string
Credential name pattern to be filtered
Example:
```
CREDNAM
```
owner: string
Credential owner
Example:
```
SYSMAN
```
page: string

system generated page token used in the self, next and previous links.
scope: string
Scope of the Named Credential. i.e. GLOBAL or INSTANCE
Example:
```
GLOBAL
```
sort: string
the order of the result set with direction. Allowed sort fields are name, owner, targetType. Allowed directions are ASC and DESC. To sort more than one field, provide comma separated values like field1:direction1,field2:direction2
Example:
```
type:ASC,name:DESC
```
targetName: string
target name of the named credential
Example:
```
host.oracle.com
```
targetNameContains: string
target name of the named credential to be filtered
Example:
```
myhostname
```
targetTypeName: string
Name of the target type of the named credential
Example:
```
host
```
targetUsername: string
Username of the target
Example:
```
root
```
targetUsernameContains: string
Username of the target to be filtered
Example:
```
SYS
```

There's no request body for this operation.

Response

Supported Media Types

application/json

200 Response

List of named credentials returned successfully

Root Schema : NamedCredentialCollection

Type: object

This is the representation of list of Named credentials.

Show Source

count(required): integer

the number of Named credentials in this page

Example: 20
items(required): array items

the Named credentials list
links(required): object links

Read Only: true

the result set navigation links
total: integer

Total number of items that are available (for all the pages)

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

Nested Schema : items

Type: array

the Named credentials list

Show Source

Array of: object NamedCredentialSummary

Schema object for Named Credential information used to return a list

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

Nested Schema : links

Type: object

Read Only: true

the result set navigation links

Show Source

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

Nested Schema : NamedCredentialSummary

Type: object

Schema object for Named Credential information used to return a list

Show Source

id: string

Unique identifier for a named credential

Example: B0FBBE587FD201E2E0537013790A7D03
link: object link

the named credential related 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"
                            }
                        }
                    ]
                }
            }
        }
    }
}

Match All

Show Source

object NamedCredentialCommon

Common properties for a Named Credential

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

Nested Schema : link

Type: object

the named credential related link

Show Source

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

Nested Schema : NamedCredentialCommon

Type: object

Common properties for a Named Credential

Show Source

authenticatingTargetTypeName(required): string

Name of the Authenticating target type of the named credential

Example: host
description: string

Description for a named credential

Example: Named credential for SYSMAN user hosts
name(required): string

Name for a named credential

Example: NAMEDCRED1
owner: string

User owner of the named credential

Example: SYSMAN
scope(required): string

Named credential scope

Example: INSTANCE
targetName: string

Target instance name for which named credential is authenticated to

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

Name of the target type

Example: host
targetUsername: string

Username of the target

Example: root
type(required): string

Named Credential type

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

Nested Schema : self

Match All

Show Source

object Link

Represents a link(could be self, previous or next)
The link to the Named Credential
Example: { "href":"/em/api/namedCredentials/B0FBBE587FD201E2E0537013790A7D03" }

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

Nested Schema : Link

Type: object

Represents a link(could be self, previous or next)

Show Source

href: string

URL for Link

Example: /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"
        }
    }
}

Nested Schema : next

Match All

Show Source

object Link

Represents a link(could be self, previous or next)
Example: { "href":"/em/api/namedCredentials?page=NEXT_PAGE_TOKEN" }

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

Nested Schema : previous

Match All

Show Source

object Link

Represents a link(could be self, previous or next)
Example: { "href":"/em/api/namedCredentials?page=PREVIOUS_PAGE_TOKEN" }

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

Nested Schema : self

Match All

Show Source

object Link

Represents a link(could be self, previous or next)
Example: { "href":"/em/api/namedCredentials?page=CURRENT_PAGE_TOKEN" }

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

Examples

400 Response

Bad Request. The payload is null or missing some parameters

Root Schema : ErrorResponse

Type: object

Error response

Show Source

code(required): string

A short error code that defines the error, meant for programmatic parsing
message(required): string

A human-readable error 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 Response

Unauthorized. The user does not have permissions to perform the requested operation

Root Schema : ErrorResponse

Type: object

Error response

Show Source

code(required): string

A short error code that defines the error, meant for programmatic parsing
message(required): string

A human-readable error 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 Response

Not Found. The requested REST API URL is not found.

Root Schema : ErrorResponse

Type: object

Error response

Show Source

code(required): string

A short error code that defines the error, meant for programmatic parsing
message(required): string

A human-readable error 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 Response

Internal Server Error. Exception in execution of REST API.

Root Schema : ErrorResponse

Type: object

Error response

Show Source

code(required): string

A short error code that defines the error, meant for programmatic parsing
message(required): string

A human-readable error 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 Response

Service Unavailable. The server is unable to process the request.

Root Schema : ErrorResponse

Type: object

Error response

Show Source

code(required): string

A short error code that defines the error, meant for programmatic parsing
message(required): string

A human-readable error 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"
        }
    }
}