Get the named credential with the given id
get
https://EM_HOST:EM_CONSOLE_HTTPS_PORT/em/api/namedCredentials/{namedCredentialId}
Returns Named Credential details like Name, Description, Owner, Target Type, Target Name, etc.
Request
Path Parameters
-
namedCredentialId(required): string
Id of a named credential
Query Parameters
-
fetchAltCredAttributes: boolean
Determines whether to fetch attributes from PAM system or not. If not sent, default is true.Example:
false
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
Named credentials returned successfully
Root Schema : NamedCredential
Type:
object
Schema object to hold Named Credential data to return on post operation
Show Source
-
attributes: object
attributes
Additional Properties Allowed: additionalPropertiesRepresents a map of name-value for the attributes for the named credential
-
credMapping: object
credMapping
Additional Properties Allowed: additionalPropertiesMapping of credential provider to the attributes required by the credential type
-
credProvider: string
Credential provider name configured in EMExample:
Script
-
credProviderKey: string
encodes one or more parts of the name that is used by the PAM solution to retrieve the credential contents from itExample:
EMHost/username
-
id: string
Read Only:
true
Unique identifier for a named credentialExample:B0FBBE587FD201E2E0537013790A7D03
-
links: object
links
the named credential related link
-
updatedBy: string
Read Only:
true
Username who updated the named credentialExample:SYSMAN
-
updatedDate: string
Read Only:
true
timestamp of the named credential update dateExample:09/02/22 23:29:23.000000000
Match All
Show Source
-
object
NamedCredentialCommon
Common properties for a Named Credential
Nested Schema : attributes
Type:
object
Additional Properties Allowed
Show Source
Represents a map of name-value for the attributes for the named credential
Nested Schema : credMapping
Type:
object
Additional Properties Allowed
Show Source
Mapping of credential provider to the attributes required by the credential type
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 credentialExample:
host
-
description: string
Description for a named credentialExample:
Named credential for SYSMAN user hosts
-
name(required): string
Name for a named credentialExample:
NAMEDCRED1
-
owner: string
User owner of the named credentialExample:
SYSMAN
-
scope(required): string
Named credential scopeExample:
INSTANCE
-
targetName: string
Target instance name for which named credential is authenticated toExample:
host.us.oracle.com
-
targetTypeName: string
Name of the target typeExample:
host
-
targetUsername: string
Username of the targetExample:
root
-
type(required): string
Named Credential typeExample:
HostCreds
Nested Schema : Link
Type:
object
Represents a link(could be self, previous or next)
Show Source
-
href: string
URL for LinkExample:
/em/api/<resources>?page=b2Zmc2V0OjA&limit=0
Examples
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
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
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
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