REST API for Oracle Enterprise Manager

Search for preferred credentials

post

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

Searches for matching preferred credentials based on the filters provided in the request payload.

Request

Query Parameters

includeTotal: boolean
whether total number of results shall be returned.
Example:
```
true
```
limit: integer
Minimum Value: 1

Maximum Value: 2000

Number of Preferred credentials to be fetched

Default Value: 20
Example:
```
20
```
page: string

system generated page token used in the self, next and previous links.
sort: string
the order of the result set with direction. Allowed sort fields are targetName, setName, targetTypeName, isDefault, isGlobal, isCredSetConfigured. 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
```

Supported Media Types

application/json

Root Schema : schema

Type: object

Schema object to hold preferred credential search payload

Show Source

isDefault: boolean

true when preferred credential is target type level. false when it is target instance level

Example: false
isGlobal: boolean

Default Value: false

true when preferred credential is global scope. false when it is User scope.

Example: true
setName: array setName

credential set name
setNameContains: array setNameContains

Preferred credential set name pattern to be filtered. Case sensitive.
targetName: array targetName

target name of preferred credential
targetNameContains: array targetNameContains

target name of the preferred credential to be filtered
targetTypeName(required): array targetTypeName

targetType of preferred credential

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

Nested Schema : setName

Type: array

credential set name

Show Source

Array of: string

Example: [ "CREDSET1", "CREDSET2" ]

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

Nested Schema : setNameContains

Type: array

Preferred credential set name pattern to be filtered. Case sensitive.

Show Source

Array of: string

Example: [ "set1", "set2" ]

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

Nested Schema : targetName

Type: array

target name of preferred credential

Show Source

Array of: string

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

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

Nested Schema : targetNameContains

Type: array

target name of the preferred credential to be filtered

Show Source

Array of: string

Example: [ "myhostname1", "myhostname2" ]

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

Nested Schema : targetTypeName

Type: array

targetType of preferred credential

Show Source

Array of: string

Example: [ "host1", "host2" ]

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

Examples

Response

Supported Media Types

application/json

200 Response

List of preferred credentials returned successfully

Root Schema : PreferredCredentialCollection

Type: object

This is the representation of list of preferred credentials.

Show Source

count(required): integer

the number of Preferred credentials in this page

Example: 20
items(required): array items

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

Nested Schema : items

Type: array

the Preferred credentials list

Show Source

Array of: object PreferredCredential

Schema object to hold Preferred Credential data returned from the search action

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

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

Nested Schema : PreferredCredential

Type: object

Schema object to hold Preferred Credential data returned from the search action

Show Source

credGuid: string

Unique identifier for a named credential

Example: B0FBBE587FD201E2E0537013790A7D03
isCredSetConfigured: boolean

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
links: object links

Read Only: true

the credential name and target links associated to the preferred credentials
targetTypeGuid: string

Unique identifier for target type

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

Match All

Show Source

object PreferredCredentialCommon

Common schema object to hold Preferred Credential data

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

Nested Schema : links

Type: object

Read Only: true

the credential name and target links associated to the preferred credentials

Show Source

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

Nested Schema : PreferredCredentialCommon

Type: object

Common schema object to hold Preferred Credential data

Show Source

isDefault(required): boolean

true when preferred credential is target type level. false when it is target instance level

Example: false
isGlobal(required): boolean

true when preferred credential is global scope. false when it is User scope.

Example: true
setName(required): string

Name for a credential set

Example: HostCredsNormal
targetGuid: string

Target instance id of a preferred credential.

Example: A3CDDE587FD221E2F3539013290B7F05
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

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

Nested Schema : credentialSet

Match All

Show Source

object Link

Represents a link(could be self, previous or next)
Example: { "href":"/em/api/targetTypes/host/credentialSets/HostNormalCreds" }

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

Nested Schema : namedCredential

Match All

Show Source

object Link

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

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

Nested Schema : target

Match All

Show Source

object Link

Represents a link(could be self, previous or next)
Example: { "href":"/em/api/targets/C0FCDE587FD201E2E0537013790A7D45" }

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

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/actions/searchPreferredCredential?page={NEXT_PAGE_TOKEN}" }

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Link"
        },
        {
            "example":{
                "href":"/em/api/actions/searchPreferredCredential?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/actions/searchPreferredCredential?page={PREVIOUS_PAGE_TOKEN}" }

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Link"
        },
        {
            "example":{
                "href":"/em/api/actions/searchPreferredCredential?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/actions/searchPreferredCredential?page={CURRENT_PAGE_TOKEN}" }

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