Jump to

• Request
• Response

Test the preferred credential against the target

post

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

Instance credentials are tested against the credential target. Global credentials are tested against the target provided.

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 details for test action. When targetGuid is not passed, targetName and targetTypeName are required

Match All

Schema object to hold Preferred Credential details for test action. When targetGuid is not passed, targetName and targetTypeName are required

Show Source

• object PreferredCredentialCommon
  Common schema object to hold Preferred Credential data

{
    "type":"object",
    "description":"Schema object to hold Preferred Credential details for test action. When targetGuid is not passed, targetName and targetTypeName are required",
    "required":[
        "setName",
        "isGlobal",
        "isDefault"
    ],
    "allOf":[
        {
            "$ref":"#/components/schemas/PreferredCredentialCommon"
        }
    ]
}

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

Back to Top

Response

204 Response

Preferred credential tested successfully

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