Jump to

• Request
• Response

Update an existing named credential

put

https://EM_HOST:EM_CONSOLE_HTTPS_PORT/em/api/namedCredentials/{namedCredentialId}

Modifies an existing Named Credential details like Name, Description, Owner, Target Type, Target Name, etc.

Request

Path Parameters

• namedCredentialId(required): string
  Id of a named credential

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: array

Show Source

• Array of: object ReplaceNamedCredentialDetailsSummary
  schema object to hold Named Credential update data

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ReplaceNamedCredentialDetailsSummary"
    }
}

Nested Schema : ReplaceNamedCredentialDetailsSummary

Type: object

schema object to hold Named Credential update data

Show Source

• attributes: object attributes
  Additional Properties Allowed: additionalProperties

  Represents a map of name-value for the attributes for the named credential
• authenticationTestTargetName: string
  Test target name

  Example: server1.example.com
• authenticationTestTargetTypeName: string
  Name of the test target type

  Example: host
• credMapping: string
  Name of the mapping configured for the credential provider to the credential type attributes

  Example: ScripttoHostCreds
• credProvider: string
  Credential provider name configured in EM

  Example: Script
• credProviderKey: string
  encodes one or more parts of the name that is used by the PAM solution to retrieve the credential contents from it

  Example: EMHost/username
• description: string
  Description for a named credential

  Example: Named credential for SYSMAN user hosts
• isAltCredStorage: boolean
  Indicates that an external credential storage (PAM) will be used to get the passwords or sensitive data

  Example: true
• isAuthenticationTestRequired: boolean
  Perform an authentication test if this value is true

  Example: true
• localInputFiles: object localInputFiles
  Additional Properties Allowed: additionalProperties

  Represents a map of name-value for an attribute value (from attributes property) being replaced by the content of a local file.
• name(required): string
  Name for a named credential

  Example: NAMEDCRED1
• owner: string
  User owner of the named credential

  Example: SYSMAN
• removeAttributes: boolean
  Unsets all existing credential column values.

  Example: true
• scope: 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: string
  Named Credential type

  Example: HostCreds

{
    "type":"object",
    "description":"schema object to hold Named Credential update data",
    "required":[
        "name"
    ],
    "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"
        },
        "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"
        },
        "isAuthenticationTestRequired":{
            "type":"boolean",
            "description":"Perform an authentication test if this value is true",
            "example":true
        },
        "authenticationTestTargetName":{
            "type":"string",
            "description":"Test target name",
            "example":"server1.example.com"
        },
        "authenticationTestTargetTypeName":{
            "type":"string",
            "description":"Name of the test target type",
            "example":"host"
        },
        "removeAttributes":{
            "type":"boolean",
            "description":"Unsets all existing credential column values.",
            "example":true
        },
        "attributes":{
            "type":"object",
            "description":"Represents a map of name-value for the attributes for the named credential",
            "additionalProperties":{
                "type":"string"
            }
        },
        "localInputFiles":{
            "type":"object",
            "description":"Represents a map of name-value for an attribute value (from attributes property) being replaced by the content of a local file.",
            "additionalProperties":{
                "type":"string"
            }
        },
        "isAltCredStorage":{
            "type":"boolean",
            "description":"Indicates that an external credential storage (PAM) will be used to get the passwords or sensitive data",
            "example":true
        },
        "credProvider":{
            "type":"string",
            "description":"Credential provider name configured in EM",
            "example":"Script"
        },
        "credProviderKey":{
            "type":"string",
            "description":"encodes one or more parts of the name that is used by the PAM solution to retrieve the credential contents from it",
            "example":"EMHost/username"
        },
        "credMapping":{
            "type":"string",
            "description":"Name of the mapping configured for the credential provider to the credential type attributes",
            "example":"ScripttoHostCreds"
        }
    }
}

Nested Schema : attributes

Type: object

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "description":"Represents a map of name-value for the attributes for the named credential",
    "additionalProperties":{
        "type":"string"
    }
}

Represents a map of name-value for the attributes for the named credential

Nested Schema : localInputFiles

Type: object

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "description":"Represents a map of name-value for an attribute value (from attributes property) being replaced by the content of a local file.",
    "additionalProperties":{
        "type":"string"
    }
}

Represents a map of name-value for an attribute value (from attributes property) being replaced by the content of a local file.

Examples

Select an example Request payload 1

Back to Top

Response

Supported Media Types

• application/json

200 Response

Named credentials modified successfully

Body ()

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: additionalProperties

  Represents a map of name-value for the attributes for the named credential
• credMapping: object credMapping
  Additional Properties Allowed: additionalProperties

  Mapping of credential provider to the attributes required by the credential type
• credProvider: string
  Credential provider name configured in EM

  Example: Script
• credProviderKey: string
  encodes one or more parts of the name that is used by the PAM solution to retrieve the credential contents from it

  Example: EMHost/username
• id: string
  Read Only: true

  Unique identifier for a named credential

  Example: B0FBBE587FD201E2E0537013790A7D03
• links: object links
  the named credential related link
• updatedBy: string
  Read Only: true

  Username who updated the named credential

  Example: SYSMAN
• updatedDate: string
  Read Only: true

  timestamp of the named credential update date

  Example: 09/02/22 23:29:23.000000000

{
    "type":"object",
    "description":"Schema object to hold Named Credential data to return on post operation",
    "allOf":[
        {
            "$ref":"#/components/schemas/NamedCredentialCommon"
        }
    ],
    "properties":{
        "id":{
            "readOnly":true,
            "type":"string",
            "description":"Unique identifier for a named credential",
            "example":"B0FBBE587FD201E2E0537013790A7D03"
        },
        "updatedDate":{
            "readOnly":true,
            "type":"string",
            "description":"timestamp of the named credential update date",
            "example":"09/02/22 23:29:23.000000000"
        },
        "updatedBy":{
            "readOnly":true,
            "type":"string",
            "description":"Username who updated the named credential",
            "example":"SYSMAN"
        },
        "attributes":{
            "type":"object",
            "description":"Represents a map of name-value for the attributes for the named credential",
            "additionalProperties":{
                "type":"string"
            }
        },
        "credProvider":{
            "type":"string",
            "description":"Credential provider name configured in EM",
            "example":"Script"
        },
        "credProviderKey":{
            "type":"string",
            "description":"encodes one or more parts of the name that is used by the PAM solution to retrieve the credential contents from it",
            "example":"EMHost/username"
        },
        "credMapping":{
            "type":"object",
            "description":"Mapping of credential provider to the attributes required by the credential type",
            "additionalProperties":{
                "type":"string"
            }
        },
        "links":{
            "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

Schema object to hold Named Credential data to return on post operation

Show Source

• object NamedCredentialCommon
  Common properties for a Named Credential

{
    "type":"object",
    "description":"Schema object to hold Named Credential data to return on post operation",
    "allOf":[
        {
            "$ref":"#/components/schemas/NamedCredentialCommon"
        }
    ],
    "properties":{
        "id":{
            "readOnly":true,
            "type":"string",
            "description":"Unique identifier for a named credential",
            "example":"B0FBBE587FD201E2E0537013790A7D03"
        },
        "updatedDate":{
            "readOnly":true,
            "type":"string",
            "description":"timestamp of the named credential update date",
            "example":"09/02/22 23:29:23.000000000"
        },
        "updatedBy":{
            "readOnly":true,
            "type":"string",
            "description":"Username who updated the named credential",
            "example":"SYSMAN"
        },
        "attributes":{
            "type":"object",
            "description":"Represents a map of name-value for the attributes for the named credential",
            "additionalProperties":{
                "type":"string"
            }
        },
        "credProvider":{
            "type":"string",
            "description":"Credential provider name configured in EM",
            "example":"Script"
        },
        "credProviderKey":{
            "type":"string",
            "description":"encodes one or more parts of the name that is used by the PAM solution to retrieve the credential contents from it",
            "example":"EMHost/username"
        },
        "credMapping":{
            "type":"object",
            "description":"Mapping of credential provider to the attributes required by the credential type",
            "additionalProperties":{
                "type":"string"
            }
        },
        "links":{
            "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 : attributes

Type: object

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "description":"Represents a map of name-value for the attributes for the named credential",
    "additionalProperties":{
        "type":"string"
    }
}

Represents a map of name-value for the attributes for the named credential

Nested Schema : credMapping

Type: object

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "description":"Mapping of credential provider to the attributes required by the credential type",
    "additionalProperties":{
        "type":"string"
    }
}

Mapping of credential provider to the attributes required by the credential type

Nested Schema : links

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

The link to the Named Credential

Show Source

• object Link
  A link referencing a REST API.
• 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

A link referencing a REST API.

Show Source

• href: string
  Link URL

{
    "x-em-sdk-level":"emSDK",
    "description":"A link referencing a REST API.",
    "type":"object",
    "properties":{
        "href":{
            "description":"Link URL",
            "type":"string"
        }
    }
}

Examples

Select an example Response payload 1

400 Response

Bad Request. The payload is null or missing some parameters

Body ()

Root Schema : ErrorResponse

Type: object

Response sent back in the case of an error.

Show Source

• code: string
  Status code of the error.

  Example: IllegalArgument
• message: string
  A descriptive error message.

  Example: argument given is not supported

{
    "x-em-sdk-level":"emSDK",
    "description":"Response sent back in the case of an error.",
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Status code of the error.",
            "example":"IllegalArgument"
        },
        "message":{
            "type":"string",
            "description":"A descriptive error message.",
            "example":"argument given is not supported"
        }
    }
}

401 Response

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

Body ()

Root Schema : ErrorResponse

Type: object

Response sent back in the case of an error.

Show Source

• code: string
  Status code of the error.

  Example: IllegalArgument
• message: string
  A descriptive error message.

  Example: argument given is not supported

{
    "x-em-sdk-level":"emSDK",
    "description":"Response sent back in the case of an error.",
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Status code of the error.",
            "example":"IllegalArgument"
        },
        "message":{
            "type":"string",
            "description":"A descriptive error message.",
            "example":"argument given is not supported"
        }
    }
}

403 Response

Forbidden. The user is forbidden to perform the requested operation

Body ()

Root Schema : ErrorResponse

Type: object

Response sent back in the case of an error.

Show Source

• code: string
  Status code of the error.

  Example: IllegalArgument
• message: string
  A descriptive error message.

  Example: argument given is not supported

{
    "x-em-sdk-level":"emSDK",
    "description":"Response sent back in the case of an error.",
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Status code of the error.",
            "example":"IllegalArgument"
        },
        "message":{
            "type":"string",
            "description":"A descriptive error message.",
            "example":"argument given is not supported"
        }
    }
}

404 Response

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

Body ()

Root Schema : ErrorResponse

Type: object

Response sent back in the case of an error.

Show Source

• code: string
  Status code of the error.

  Example: IllegalArgument
• message: string
  A descriptive error message.

  Example: argument given is not supported

{
    "x-em-sdk-level":"emSDK",
    "description":"Response sent back in the case of an error.",
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Status code of the error.",
            "example":"IllegalArgument"
        },
        "message":{
            "type":"string",
            "description":"A descriptive error message.",
            "example":"argument given is not supported"
        }
    }
}

500 Response

Internal Server Error. Exception in execution of REST API.

Body ()

Root Schema : ErrorResponse

Type: object

Response sent back in the case of an error.

Show Source

• code: string
  Status code of the error.

  Example: IllegalArgument
• message: string
  A descriptive error message.

  Example: argument given is not supported

{
    "x-em-sdk-level":"emSDK",
    "description":"Response sent back in the case of an error.",
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Status code of the error.",
            "example":"IllegalArgument"
        },
        "message":{
            "type":"string",
            "description":"A descriptive error message.",
            "example":"argument given is not supported"
        }
    }
}

503 Response

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

Body ()

Root Schema : ErrorResponse

Type: object

Response sent back in the case of an error.

Show Source

• code: string
  Status code of the error.

  Example: IllegalArgument
• message: string
  A descriptive error message.

  Example: argument given is not supported

{
    "x-em-sdk-level":"emSDK",
    "description":"Response sent back in the case of an error.",
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Status code of the error.",
            "example":"IllegalArgument"
        },
        "message":{
            "type":"string",
            "description":"A descriptive error message.",
            "example":"argument given is not supported"
        }
    }
}

Back to Top