Jump to

• Request
• Response

Clear a preferred credential

post

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

Clears an existing monitoring credential for the target type or target instance and sets the 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 clearPreferredCredential post action.

Show Source

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

  Example: SYSMAN

{
    "type":"object",
    "description":"Schema object to hold Preferred Credential data required in the clearPreferredCredential post action.",
    "allOf":[
        {
            "$ref":"#/components/schemas/PreferredCredentialCommon"
        }
    ],
    "properties":{
        "forUser":{
            "type":"string",
            "description":"User for which preferred credential is being set",
            "example":"SYSMAN"
        }
    }
}

Match All

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 clearPreferredCredential post action.",
    "allOf":[
        {
            "$ref":"#/components/schemas/PreferredCredentialCommon"
        }
    ],
    "properties":{
        "forUser":{
            "type":"string",
            "description":"User for which preferred credential is being set",
            "example":"SYSMAN"
        }
    }
}

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

204 Response

Preferred credential cleared successfully

Back to Top