Lists Named Credential.
GET {{baseUrl}}/namedCredentials?compartmentId=<string>&associatedResource=<string>&type=ORACLE_DB&scope=RESOURCE&name=<string>&page=<string>&limit=10&sortBy=TIMECREATED&sortOrder=ASC
Gets a single named credential specified by the name or all the named credentials in a specific compartment.
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
compartmentId | string | (Required) The OCID of the compartment. | |
associatedResource | string | The resource associated to the named credential. | |
type | string | The type of database that is associated to the named credential. | |
scope | string | The scope of named credential. | |
name | string | The name of the named credential. | |
page | string | The page token representing the page from where the next set of paginated results | |
are retrieved. This is usually retrieved from a previous list call. | |||
limit | number | The maximum number of records returned in the paginated response. | |
sortBy | string | The field to sort information by. Only one sortOrder can be used. The default sort order | |
for ‘TIMECREATED’ is descending and the default sort order for ‘NAME’ is ascending. | |||
The ‘NAME’ sort order is case-sensitive. | |||
sortOrder | string | The option to sort information in ascending (‘ASC’) or descending (‘DESC’) order. Ascending order is the default order. |
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
opc-request-id | string | The client request ID for tracing. | |
Accept | string |
RESPONSES
status: OK
{"items":[{"name":"\u003cstring\u003e","id":"\u003cstring\u003e","compartmentId":"\u003cstring\u003e","lifecycleState":"FAILED","lifecycleDetails":"\u003cstring\u003e","type":"ORACLE_DB","scope":"RESOURCE","description":"\u003cstring\u003e","timeCreated":"\u003cdateTime\u003e","timeUpdated":"\u003cdateTime\u003e","definedTags":{"veniam_683":{"exc5":{},"tempor_a":{},"labore_fff":{}},"officia_e41":{"do_667":{},"in9":{},"minim993":{}}},"freeformTags":{"aute543":"\u003cstring\u003e","quis__":"\u003cstring\u003e","in_b":"\u003cstring\u003e","velit06":"\u003cstring\u003e"}},{"name":"\u003cstring\u003e","id":"\u003cstring\u003e","compartmentId":"\u003cstring\u003e","lifecycleState":"CREATING","lifecycleDetails":"\u003cstring\u003e","type":"ORACLE_DB","scope":"RESOURCE","description":"\u003cstring\u003e","timeCreated":"\u003cdateTime\u003e","timeUpdated":"\u003cdateTime\u003e","definedTags":{"sit5b":{"dolore_e":{},"dolore_3be":{},"auteb":{}},"nostrud_e":{"in9a":{},"dolore_8":{}}},"freeformTags":{"eu_4a9":"\u003cstring\u003e","nulla31_":"\u003cstring\u003e","occaecat_c5":"\u003cstring\u003e"}}]}