Jump to

• Request
• Response

Modify an existing credential set

put

https://EM_HOST:EM_CONSOLE_HTTPS_PORT/em/api/targetTypes/{type}/credentialSets/{credSet}

Modify an existing credential set for the given target type and credential set. It only updates the privileges of the credential set type.

Request

Path Parameters

• credSet(required): string
  the credential set name
• type(required): string
  the target type

Supported Media Types

• application/json+merge-path

Request Body - application/json+merge-path ()

Root Schema : schema

Type: object

Request payload to update a credential set

Match All

Show Source

• object CredentialSetPrivilegesCommon
  It represents information of a Credential Set privileges

{
    "x-em-sdk-level":"emSDK",
    "description":"Request payload to update a credential set",
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/CredentialSetPrivilegesCommon"
        }
    ]
}

Nested Schema : CredentialSetPrivilegesCommon

Type: object

It represents information of a Credential Set privileges

Show Source

• getPrivilege: string
  privilege for the get operation for the credential set

  Example: OPERATOR_TARGET
• updateDefaultPrivilege: string
  default privilege for the update operation for the credential set

  Example: FULL_ANY_TARGET
• updatePrivilege: string
  privilege for the update operation for the credential set

  Example: FULL_TARGET

{
    "type":"object",
    "description":"It represents information of a Credential Set privileges",
    "properties":{
        "getPrivilege":{
            "type":"string",
            "description":"privilege for the get operation for the credential set",
            "example":"OPERATOR_TARGET"
        },
        "updatePrivilege":{
            "type":"string",
            "description":"privilege for the update operation for the credential set",
            "example":"FULL_TARGET"
        },
        "updateDefaultPrivilege":{
            "type":"string",
            "description":"default privilege for the update operation for the credential set",
            "example":"FULL_ANY_TARGET"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Credential set is updated successfully

Body ()

Root Schema : CredentialSet

Type: object

It represents a Credential Set

Show Source

• links: object links
  Read Only: true

  The credential set related links
• supportedCredentialTypesInfo: array supportedCredentialTypesInfo
  List of supported credential types and columns

{
    "type":"object",
    "description":"It represents a Credential Set",
    "allOf":[
        {
            "$ref":"#/components/schemas/CredentialSetCommon"
        },
        {
            "$ref":"#/components/schemas/CredentialSetPrivilegesCommon"
        }
    ],
    "properties":{
        "supportedCredentialTypesInfo":{
            "type":"array",
            "description":"List of supported credential types and columns",
            "items":{
                "$ref":"#/components/schemas/SupportedCredentialTypesInfo"
            }
        },
        "links":{
            "type":"object",
            "readOnly":true,
            "description":"The credential set related links",
            "properties":{
                "self":{
                    "allOf":[
                        {
                            "$ref":"#/components/schemas/Link"
                        },
                        {
                            "description":"The link to the credential set"
                        },
                        {
                            "example":{
                                "href":"/em/api/targetTypes/{type}/credentialSets/{credSet}"
                            }
                        }
                    ]
                }
            }
        }
    }
}

Match All

Show Source

• object CredentialSetCommon
  It represents information of a Credential Set
• object CredentialSetPrivilegesCommon
  It represents information of a Credential Set privileges

{
    "type":"object",
    "description":"It represents a Credential Set",
    "allOf":[
        {
            "$ref":"#/components/schemas/CredentialSetCommon"
        },
        {
            "$ref":"#/components/schemas/CredentialSetPrivilegesCommon"
        }
    ],
    "properties":{
        "supportedCredentialTypesInfo":{
            "type":"array",
            "description":"List of supported credential types and columns",
            "items":{
                "$ref":"#/components/schemas/SupportedCredentialTypesInfo"
            }
        },
        "links":{
            "type":"object",
            "readOnly":true,
            "description":"The credential set related links",
            "properties":{
                "self":{
                    "allOf":[
                        {
                            "$ref":"#/components/schemas/Link"
                        },
                        {
                            "description":"The link to the credential set"
                        },
                        {
                            "example":{
                                "href":"/em/api/targetTypes/{type}/credentialSets/{credSet}"
                            }
                        }
                    ]
                }
            }
        }
    }
}

Nested Schema : links

Type: object

Read Only: true

The credential set related links

Show Source

• self: self

{
    "type":"object",
    "readOnly":true,
    "description":"The credential set related links",
    "properties":{
        "self":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/Link"
                },
                {
                    "description":"The link to the credential set"
                },
                {
                    "example":{
                        "href":"/em/api/targetTypes/{type}/credentialSets/{credSet}"
                    }
                }
            ]
        }
    }
}

Nested Schema : supportedCredentialTypesInfo

Type: array

List of supported credential types and columns

Show Source

• Array of: object SupportedCredentialTypesInfo
  Supported credential type and its columns associated

{
    "type":"array",
    "description":"List of supported credential types and columns",
    "items":{
        "$ref":"#/components/schemas/SupportedCredentialTypesInfo"
    }
}

Nested Schema : CredentialSetCommon

Type: object

It represents information of a Credential Set

Show Source

• authenticatingTargetTypeName: string
  Name of the Authentication target type of the credential set

  Example: host
• isMonitoringCredentialSet: boolean
  true when it is a monitoring credential set. false when it is preferred credential set.

  Example: true
• setName: string
  Name for of the credential set

  Example: MONNAMEDCREDSET1
• setNameDisplayName: string
  display name of the credential set

  Example: Host monitoring credentials
• targetTypeName: string
  name of the target type of the credential set

  Example: host

{
    "type":"object",
    "description":"It represents information of a Credential Set",
    "properties":{
        "setName":{
            "type":"string",
            "description":"Name for of the credential set",
            "example":"MONNAMEDCREDSET1"
        },
        "targetTypeName":{
            "type":"string",
            "description":"name of the target type of the credential set",
            "example":"host"
        },
        "authenticatingTargetTypeName":{
            "type":"string",
            "description":"Name of the Authentication target type of the credential set",
            "example":"host"
        },
        "isMonitoringCredentialSet":{
            "type":"boolean",
            "description":"true when it is a monitoring credential set. false when it is preferred credential set.",
            "example":true
        },
        "setNameDisplayName":{
            "type":"string",
            "description":"display name of the credential set",
            "example":"Host monitoring credentials"
        }
    }
}

Nested Schema : CredentialSetPrivilegesCommon

Type: object

It represents information of a Credential Set privileges

Show Source

• getPrivilege: string
  privilege for the get operation for the credential set

  Example: OPERATOR_TARGET
• updateDefaultPrivilege: string
  default privilege for the update operation for the credential set

  Example: FULL_ANY_TARGET
• updatePrivilege: string
  privilege for the update operation for the credential set

  Example: FULL_TARGET

{
    "type":"object",
    "description":"It represents information of a Credential Set privileges",
    "properties":{
        "getPrivilege":{
            "type":"string",
            "description":"privilege for the get operation for the credential set",
            "example":"OPERATOR_TARGET"
        },
        "updatePrivilege":{
            "type":"string",
            "description":"privilege for the update operation for the credential set",
            "example":"FULL_TARGET"
        },
        "updateDefaultPrivilege":{
            "type":"string",
            "description":"default privilege for the update operation for the credential set",
            "example":"FULL_ANY_TARGET"
        }
    }
}

Nested Schema : self

Match All

Show Source

• object Link
  Represents a link(could be self, previous or next)
• The link to the credential set
• Example: { "href":"/em/api/targetTypes/{type}/credentialSets/{credSet}" }

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Link"
        },
        {
            "description":"The link to the credential set"
        },
        {
            "example":{
                "href":"/em/api/targetTypes/{type}/credentialSets/{credSet}"
            }
        }
    ]
}

Nested Schema : Link

Type: object

Represents a link(could be self, previous or next)

Show Source

• href: string
  URL for Link

  Example: /em/api/<resources>?page=b2Zmc2V0OjA&limit=0

{
    "type":"object",
    "description":"Represents a link(could be self, previous or next)",
    "properties":{
        "href":{
            "type":"string",
            "description":"URL for Link",
            "example":"/em/api/<resources>?page=b2Zmc2V0OjA&limit=0"
        }
    }
}

Nested Schema : SupportedCredentialTypesInfo

Type: object

Supported credential type and its columns associated

Show Source

• name: string
  Name of the credential type

  Example: HostSSHCreds
• typeColumns: object typeColumns
  Additional Properties Allowed: additionalProperties

  Represents a map of type columns for the credential set. The key is the column name and the value represents if this column is sensitive or not.

{
    "type":"object",
    "description":"Supported credential type and its columns associated",
    "properties":{
        "name":{
            "type":"string",
            "description":"Name of the credential type",
            "example":"HostSSHCreds"
        },
        "typeColumns":{
            "type":"object",
            "description":"Represents a map of type columns for the credential set. The key is the column name and the value represents if this column  is sensitive or not.",
            "additionalProperties":{
                "type":"string"
            }
        }
    }
}

Nested Schema : typeColumns

Type: object

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "description":"Represents a map of type columns for the credential set. The key is the column name and the value represents if this column  is sensitive or not.",
    "additionalProperties":{
        "type":"string"
    }
}

Represents a map of type columns for the credential set. The key is the column name and the value represents if this column is sensitive or not.

Examples

Select an example Response 1

400 Response

indicates that there has been a processing error or an illegal argument, like an unsupported property.

Body ()

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

{
    "description":"Error response",
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error string",
            "type":"string"
        }
    }
}

401 Response

client is not authenticated

Body ()

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

{
    "description":"Error response",
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error string",
            "type":"string"
        }
    }
}

403 Response

Forbidden

Body ()

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

{
    "description":"Error response",
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error string",
            "type":"string"
        }
    }
}

404 Response

target not found or not authorized

Body ()

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

{
    "description":"Error response",
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error string",
            "type":"string"
        }
    }
}

500 Response

internal error serving the request

Body ()

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

{
    "description":"Error response",
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error string",
            "type":"string"
        }
    }
}

503 Response

indicates that a required service is not available.

Body ()

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

{
    "description":"Error response",
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error string",
            "type":"string"
        }
    }
}

Back to Top