Jump to

• Request
• Response

Set a named credential as preferred credential

post

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

Sets an existing named credential as preferred for the target type/target instance and set name provided in the payload.

Request

There are no request parameters for this operation.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Schema object to hold Preferred Credential data required in the setPreferredCredential action. credGuid can be passed or credName and credOwner combination in order to find the named credential to set as preferred.

Show Source

• authenticationTargetType: string
  The authenticating target type. Defaults to targetTypeName

  Example: host
• credGuid: string
  Unique identifier for a named credential

  Example: B0FBBE587FD201E2E0537013790A7D03
• credName: string
  Name for a named credential

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

  Example: SYSMAN
• forUser: string
  User for which preferred credential is being set

  Example: SYSMAN
• isAuthenticationRequired: boolean
  true if authentication is required before saving credential

  Example: false

{
    "type":"object",
    "description":"Schema object to hold Preferred Credential data required in the setPreferredCredential action. credGuid can be passed or credName and credOwner combination in order to find the named credential to set as preferred.",
    "allOf":[
        {
            "$ref":"#/components/schemas/PreferredCredentialCommon"
        }
    ],
    "properties":{
        "credName":{
            "type":"string",
            "description":"Name for a named credential",
            "example":"NAMEDCRED1"
        },
        "credOwner":{
            "type":"string",
            "description":"User owner of the named credential",
            "example":"SYSMAN"
        },
        "credGuid":{
            "type":"string",
            "description":"Unique identifier for a named credential",
            "example":"B0FBBE587FD201E2E0537013790A7D03"
        },
        "forUser":{
            "type":"string",
            "description":"User for which preferred credential is being set",
            "example":"SYSMAN"
        },
        "isAuthenticationRequired":{
            "type":"boolean",
            "description":"true if authentication is required before saving credential",
            "example":false
        },
        "authenticationTargetType":{
            "type":"string",
            "description":"The authenticating target type. Defaults to targetTypeName",
            "example":"host"
        }
    }
}

Match All

Schema object to hold Preferred Credential data required in the setPreferredCredential action. credGuid can be passed or credName and credOwner combination in order to find the named credential to set as preferred.

Show Source

• object PreferredCredentialCommon
  Common schema object to hold Preferred Credential data

{
    "type":"object",
    "description":"Schema object to hold Preferred Credential data required in the setPreferredCredential action. credGuid can be passed or credName and credOwner combination in order to find the named credential to set as preferred.",
    "allOf":[
        {
            "$ref":"#/components/schemas/PreferredCredentialCommon"
        }
    ],
    "properties":{
        "credName":{
            "type":"string",
            "description":"Name for a named credential",
            "example":"NAMEDCRED1"
        },
        "credOwner":{
            "type":"string",
            "description":"User owner of the named credential",
            "example":"SYSMAN"
        },
        "credGuid":{
            "type":"string",
            "description":"Unique identifier for a named credential",
            "example":"B0FBBE587FD201E2E0537013790A7D03"
        },
        "forUser":{
            "type":"string",
            "description":"User for which preferred credential is being set",
            "example":"SYSMAN"
        },
        "isAuthenticationRequired":{
            "type":"boolean",
            "description":"true if authentication is required before saving credential",
            "example":false
        },
        "authenticationTargetType":{
            "type":"string",
            "description":"The authenticating target type. Defaults to targetTypeName",
            "example":"host"
        }
    }
}

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

Examples

Select an example Request Payload 1 Request Payload 2 Request Payload 3

Back to Top

Response

Supported Media Types

• application/json

200 Response

Preferred credential set successfully

Body ()

Root 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

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

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
  A link referencing a REST API.
• 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
  A link referencing a REST API.
• 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
  A link referencing a REST API.
• Example: { "href":"/em/api/targets/C0FCDE587FD201E2E0537013790A7D45" }

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

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

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

409 Response

Conflict

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