Jump to

• Request
• Response

List credential sets

get

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

Gives list of target type credential Sets. Returns the first page of results by ordering name in ASC by default.

Request

Path Parameters

• type(required): string
  the target type

Query Parameters

• include: string
  If include=total information about total number of returned records will be included in the response
• isMonitoringCredentialSet: boolean
  true when it is a monitoring credential set. false when it is preferred credential set.

  Example:

  false

• limit: integer
  Minimum Value: 1

  Maximum Value: 2000

  Number of Credential Sets to be fetched

  Default Value: 20

  Example:

  20

• page: string
  system generated page token used in the self, next and previous links.
• setName: string
  Credential Set name

  Example:

  CREDSETNAME

• setNameMatches: string
  Set name pattern to be filtered

  Example:

  ASMCredsMo

• sort: string
  the order of the result set with direction. Allowed sort fields are target type and set name. Allowed directions are asc and desc. To sort more than one field, provide comma separated values like field1:direction1,field2:direction2

  Example:

  type:ASC,name:DESC

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

List of credentials set returned successfully

Body ()

Root Schema : CredentialSetCollection

Type: object

This is the representation of list of credential sets.

Show Source

• count(required): integer
  the number of credential sets in this page

  Example: 20
• items(required): array items
  the credentials Set list
• links(required): object links
  Read Only: true

  the result set navigation links

{
    "description":"This is the representation of list of credential sets.",
    "type":"object",
    "required":[
        "items",
        "links",
        "count"
    ],
    "properties":{
        "count":{
            "type":"integer",
            "description":"the number of credential sets in this page",
            "example":20
        },
        "links":{
            "type":"object",
            "readOnly":true,
            "description":"the result set navigation links",
            "properties":{
                "self":{
                    "allOf":[
                        {
                            "$ref":"#/components/schemas/Link"
                        },
                        {
                            "example":{
                                "href":"/em/api/targetTypes/actions/searchCredentialSets/?page=CURRENT_PAGE_TOKEN"
                            }
                        }
                    ]
                },
                "previous":{
                    "allOf":[
                        {
                            "$ref":"#/components/schemas/Link"
                        },
                        {
                            "example":{
                                "href":"/em/api/targetTypes/actions/searchCredentialSets?page=PREVIOUS_PAGE_TOKEN"
                            }
                        }
                    ]
                },
                "next":{
                    "allOf":[
                        {
                            "$ref":"#/components/schemas/Link"
                        },
                        {
                            "example":{
                                "href":"/em/api/targetTypes/actions/searchCredentialSets?page=NEXT_PAGE_TOKEN"
                            }
                        }
                    ]
                }
            }
        },
        "items":{
            "type":"array",
            "description":"the credentials Set list",
            "items":{
                "$ref":"#/components/schemas/CredentialSetSummary"
            }
        }
    }
}

Nested Schema : items

Type: array

the credentials Set list

Show Source

• Array of: object CredentialSetSummary
  It represents information of a Credential Set

{
    "type":"array",
    "description":"the credentials Set list",
    "items":{
        "$ref":"#/components/schemas/CredentialSetSummary"
    }
}

Nested Schema : links

Type: object

Read Only: true

the result set navigation links

Show Source

• next: next
• previous: previous
• self: self

{
    "type":"object",
    "readOnly":true,
    "description":"the result set navigation links",
    "properties":{
        "self":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/Link"
                },
                {
                    "example":{
                        "href":"/em/api/targetTypes/actions/searchCredentialSets/?page=CURRENT_PAGE_TOKEN"
                    }
                }
            ]
        },
        "previous":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/Link"
                },
                {
                    "example":{
                        "href":"/em/api/targetTypes/actions/searchCredentialSets?page=PREVIOUS_PAGE_TOKEN"
                    }
                }
            ]
        },
        "next":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/Link"
                },
                {
                    "example":{
                        "href":"/em/api/targetTypes/actions/searchCredentialSets?page=NEXT_PAGE_TOKEN"
                    }
                }
            ]
        }
    }
}

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

Nested Schema : next

Match All

Show Source

• object Link
  Represents a link(could be self, previous or next)
• Example: { "href":"/em/api/targetTypes/actions/searchCredentialSets?page=NEXT_PAGE_TOKEN" }

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Link"
        },
        {
            "example":{
                "href":"/em/api/targetTypes/actions/searchCredentialSets?page=NEXT_PAGE_TOKEN"
            }
        }
    ]
}

Nested Schema : previous

Match All

Show Source

• object Link
  Represents a link(could be self, previous or next)
• Example: { "href":"/em/api/targetTypes/actions/searchCredentialSets?page=PREVIOUS_PAGE_TOKEN" }

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Link"
        },
        {
            "example":{
                "href":"/em/api/targetTypes/actions/searchCredentialSets?page=PREVIOUS_PAGE_TOKEN"
            }
        }
    ]
}

Nested Schema : self

Match All

Show Source

• object Link
  Represents a link(could be self, previous or next)
• Example: { "href":"/em/api/targetTypes/actions/searchCredentialSets/?page=CURRENT_PAGE_TOKEN" }

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Link"
        },
        {
            "example":{
                "href":"/em/api/targetTypes/actions/searchCredentialSets/?page=CURRENT_PAGE_TOKEN"
            }
        }
    ]
}

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

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

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