Jump to

• Request
• Response

Create a credential set

post

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

Creates a new credential set for the given target. Returns the created Credential Set.

Request

Path Parameters

• type(required): string
  the target type

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Request payload to create a credential set

Show Source

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

  Example: host
• description: string
  Credential Set description

  Example: My custom credential set for host target type
• isMonitoringCredentialSet: boolean
  true when it is a monitoring credential set. false when it is preferred credential set.

  Example: true
• setName(required): string
  Name of the Credential Set

  Example: MY_CUSTOM_CRED_SET1
• supportedCredentialTypes(required): array supportedCredentialTypes
  Supported Credential Types

{
    "x-em-sdk-level":"emSDK",
    "description":"Request payload to create a credential set",
    "type":"object",
    "required":[
        "setName",
        "supportedCredentialTypes"
    ],
    "properties":{
        "setName":{
            "type":"string",
            "description":"Name of the Credential Set",
            "example":"MY_CUSTOM_CRED_SET1"
        },
        "description":{
            "type":"string",
            "description":"Credential Set description",
            "example":"My custom credential set for host target type"
        },
        "authenticatingTargetTypeName":{
            "type":"string",
            "description":"Name of the Authentication target type of the credential set",
            "example":"host"
        },
        "supportedCredentialTypes":{
            "type":"array",
            "description":"Supported Credential Types",
            "items":{
                "type":"string",
                "example":"HostCreds, HostSSHCreds"
            }
        },
        "isMonitoringCredentialSet":{
            "type":"boolean",
            "description":"true when it is a monitoring credential set. false when it is preferred credential set.",
            "example":true
        }
    }
}

Nested Schema : supportedCredentialTypes

Type: array

Supported Credential Types

Show Source

• Array of: string
  Example: HostCreds, HostSSHCreds

{
    "type":"array",
    "description":"Supported Credential Types",
    "items":{
        "type":"string",
        "example":"HostCreds, HostSSHCreds"
    }
}

Examples

Select an example Request 1

Back to Top

Response

Supported Media Types

• application/json

201 Response

Credential Set created successfully

Body ()

Root Schema : CredentialSetSummary

Type: object

It represents information of a Credential Set

Show Source

• supportedCredentialTypes: array supportedCredentialTypes
  Supported Credential Types

{
    "type":"object",
    "description":"It represents information of a Credential Set",
    "allOf":[
        {
            "$ref":"#/components/schemas/CredentialSetCommon"
        }
    ],
    "properties":{
        "supportedCredentialTypes":{
            "type":"array",
            "description":"Supported Credential Types",
            "items":{
                "type":"string",
                "example":"HostCreds, HostSSHCreds"
            }
        }
    }
}

Match All

Show Source

• object CredentialSetCommon
  It represents information of a Credential Set

{
    "type":"object",
    "description":"It represents information of a Credential Set",
    "allOf":[
        {
            "$ref":"#/components/schemas/CredentialSetCommon"
        }
    ],
    "properties":{
        "supportedCredentialTypes":{
            "type":"array",
            "description":"Supported Credential Types",
            "items":{
                "type":"string",
                "example":"HostCreds, HostSSHCreds"
            }
        }
    }
}

Nested Schema : supportedCredentialTypes

Type: array

Supported Credential Types

Show Source

• Array of: string
  Example: HostCreds, HostSSHCreds

{
    "type":"array",
    "description":"Supported Credential Types",
    "items":{
        "type":"string",
        "example":"HostCreds, HostSSHCreds"
    }
}

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

Examples

Select an example Response 1

400 Response

request is not correct

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

409 Response

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

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