Jump to

• Request
• Response

Search for credential type information

post

https://EM_HOST:EM_CONSOLE_HTTPS_PORT/em/api/targetTypes/{type}/actions/searchCredentialTypeInfo

Search for credential type information of a given target type. Returns credential type information, column names, key columns.

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

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Request payload for the credential type info search. Search will filter by the given target type and credential type name. When not given, it will return information for all targets and credential types. One or both properties can be passed for filtering.

Show Source

• credentialTypeMatches: string
  credential type pattern to be filtered

  Example: HostCreds
• credentialTypeName: string
  Type of credential to be searched

  Example: HostCreds

{
    "x-em-sdk-level":"emSDK",
    "description":"Request payload for the credential type info search. Search will filter by the given target type and credential type name. When not given, it will return information for all targets and credential types. One or both properties can be passed for filtering.",
    "type":"object",
    "properties":{
        "credentialTypeName":{
            "type":"string",
            "description":"Type of credential to be searched",
            "example":"HostCreds"
        },
        "credentialTypeMatches":{
            "type":"string",
            "description":"credential type pattern to be filtered",
            "example":"HostCreds"
        }
    }
}

Examples

Select an example Request 1 Request 2

Back to Top

Response

Supported Media Types

• application/json

200 Response

List of Credential types for target types returned successfully

Body ()

Root Schema : CredentialTypeInfoCollection

Type: object

This is the representation of list of credential type info of target types.

Show Source

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

  Example: 20
• items(required): array items
  the Credential type information list
• links(required): object links
  Read Only: true

  the result set navigation links
• total: integer
  Total number of items that are available (for all the pages)

  Example: 101

{
    "description":"This is the representation of list of credential type info of target types.",
    "type":"object",
    "required":[
        "items",
        "links",
        "count"
    ],
    "properties":{
        "count":{
            "type":"integer",
            "description":"the number of credential types described in this page",
            "example":20
        },
        "total":{
            "type":"integer",
            "description":"Total number of items that are available (for all the pages)",
            "example":101
        },
        "links":{
            "type":"object",
            "readOnly":true,
            "description":"the result set navigation links",
            "properties":{
                "self":{
                    "allOf":[
                        {
                            "$ref":"#/components/schemas/Link"
                        },
                        {
                            "example":{
                                "href":"/em/api/targetTypes/actions/searchCredentialTypeInfo?page={CURRENT_PAGE_TOKEN}"
                            }
                        }
                    ]
                },
                "previous":{
                    "allOf":[
                        {
                            "$ref":"#/components/schemas/Link"
                        },
                        {
                            "example":{
                                "href":"/em/api/targetTypes/actions/searchCredentialTypeInfo?page={PREVIOUS_PAGE_TOKEN}"
                            }
                        }
                    ]
                },
                "next":{
                    "allOf":[
                        {
                            "$ref":"#/components/schemas/Link"
                        },
                        {
                            "example":{
                                "href":"/em/api/targetTypes/actions/searchCredentialTypeInfo?page={NEXT_PAGE_TOKEN}"
                            }
                        }
                    ]
                }
            }
        },
        "items":{
            "type":"array",
            "description":"the Credential type information list",
            "items":{
                "$ref":"#/components/schemas/CredentialTypeInfo"
            }
        }
    }
}

Nested Schema : items

Type: array

the Credential type information list

Show Source

• Array of: object CredentialTypeInfo
  Schema object to hold Preferred Credential data returned from the search action

{
    "type":"array",
    "description":"the Credential type information list",
    "items":{
        "$ref":"#/components/schemas/CredentialTypeInfo"
    }
}

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/searchCredentialTypeInfo?page={CURRENT_PAGE_TOKEN}"
                    }
                }
            ]
        },
        "previous":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/Link"
                },
                {
                    "example":{
                        "href":"/em/api/targetTypes/actions/searchCredentialTypeInfo?page={PREVIOUS_PAGE_TOKEN}"
                    }
                }
            ]
        },
        "next":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/Link"
                },
                {
                    "example":{
                        "href":"/em/api/targetTypes/actions/searchCredentialTypeInfo?page={NEXT_PAGE_TOKEN}"
                    }
                }
            ]
        }
    }
}

Nested Schema : CredentialTypeInfo

Type: object

Schema object to hold Preferred Credential data returned from the search action

Show Source

• supportedCredentialTypesInfo: array supportedCredentialTypesInfo
  List of supported credential types and columns
• targetTypeName: string
  name of the target type of the credential set

  Example: host

{
    "type":"object",
    "description":"Schema object to hold Preferred Credential data returned from the search action",
    "properties":{
        "targetTypeName":{
            "type":"string",
            "description":"name of the target type of the credential set",
            "example":"host"
        },
        "supportedCredentialTypesInfo":{
            "type":"array",
            "description":"List of supported credential types and columns",
            "items":{
                "$ref":"#/components/schemas/SupportedCredentialTypesInfo"
            }
        }
    }
}

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 : 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.

Nested Schema : next

Match All

Show Source

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

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Link"
        },
        {
            "example":{
                "href":"/em/api/targetTypes/actions/searchCredentialTypeInfo?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/searchCredentialTypeInfo?page={PREVIOUS_PAGE_TOKEN}" }

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Link"
        },
        {
            "example":{
                "href":"/em/api/targetTypes/actions/searchCredentialTypeInfo?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/searchCredentialTypeInfo?page={CURRENT_PAGE_TOKEN}" }

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Link"
        },
        {
            "example":{
                "href":"/em/api/targetTypes/actions/searchCredentialTypeInfo?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 Response 2

Back to Top