Jump to

• Request
• Response

Test the named credentials provided in the list

post

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

Instance credentials are tested against the credential target. Global credentials are tested against the target provided.

Request

There are no request parameters for this operation.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

This consists of list of Named Credential Test Criteria.

Show Source

• testNamedCredentialRequests: array testNamedCredentialRequests
  This represents a list of Named Credential Test Criteria

{
    "description":"This consists of list of Named Credential Test Criteria.",
    "type":"object",
    "properties":{
        "testNamedCredentialRequests":{
            "type":"array",
            "description":"This represents a list of Named Credential Test Criteria",
            "items":{
                "$ref":"#/components/schemas/TestCredentialCriteria"
            }
        }
    }
}

Nested Schema : testNamedCredentialRequests

Type: array

This represents a list of Named Credential Test Criteria

Show Source

• Array of: object TestCredentialCriteria
  This consists of data required to test a named credential

{
    "type":"array",
    "description":"This represents a list of Named Credential Test Criteria",
    "items":{
        "$ref":"#/components/schemas/TestCredentialCriteria"
    }
}

Nested Schema : TestCredentialCriteria

Type: object

This consists of data required to test a named credential

Show Source

• authenticationTestTargetName: string
  Test target name

  Example: testhost.example.com
• authenticationTestTargetTypeName: string
  Name of the test target type

  Example: host
• credentialNameAndOwnerCollection(required): array credentialNameAndOwnerCollection
  Credential name list

{
    "description":"This consists of data required to test a named credential",
    "type":"object",
    "required":[
        "credentialNameAndOwnerCollection"
    ],
    "properties":{
        "authenticationTestTargetName":{
            "type":"string",
            "description":"Test target name",
            "example":"testhost.example.com"
        },
        "authenticationTestTargetTypeName":{
            "type":"string",
            "description":"Name of the test target type",
            "example":"host"
        },
        "credentialNameAndOwnerCollection":{
            "type":"array",
            "description":"Credential name list",
            "items":{
                "$ref":"#/components/schemas/CredentialNameAndOwnerCollection"
            }
        }
    }
}

Nested Schema : credentialNameAndOwnerCollection

Type: array

Credential name list

Show Source

• Array of: object CredentialNameAndOwnerCollection
  Credential name and owner for named credential to test

{
    "type":"array",
    "description":"Credential name list",
    "items":{
        "$ref":"#/components/schemas/CredentialNameAndOwnerCollection"
    }
}

Nested Schema : CredentialNameAndOwnerCollection

Type: object

Credential name and owner for named credential to test

Show Source

• credNames(required): array credNames
  List of Named credentials for a particular owner
• credOwner: string
  Owner of named credential. If not provided it would default to current logged-in user

  Example: ADMIN1

{
    "description":"Credential name and owner for named credential to test",
    "type":"object",
    "required":[
        "credNames"
    ],
    "properties":{
        "credNames":{
            "type":"array",
            "description":"List of Named credentials for a particular owner",
            "items":{
                "type":"string",
                "example":"NAMEDCRED1, NAMEDCRED2"
            }
        },
        "credOwner":{
            "type":"string",
            "description":"Owner of named credential. If not provided it would default to current logged-in user",
            "example":"ADMIN1"
        }
    }
}

Nested Schema : credNames

Type: array

List of Named credentials for a particular owner

Show Source

• Array of: string
  Example: NAMEDCRED1, NAMEDCRED2

{
    "type":"array",
    "description":"List of Named credentials for a particular owner",
    "items":{
        "type":"string",
        "example":"NAMEDCRED1, NAMEDCRED2"
    }
}

Examples

Select an example Request Payload 1 Request Payload 2 Request Payload 3

Back to Top

Response

Supported Media Types

• application/json

200 Response

Named credentials test information is given successfully

Body ()

Root Schema : NamedCredentialTestResultCollection

Type: object

This represents the list of different Global/Target instance tested over named credentials

Show Source

• count: integer
  The number of the different Global/Target instance tested over named credentials

  Example: 5
• items: array items
  This is the list of different Global/Target instance tested over named credentials

{
    "description":"This represents the list of different Global/Target instance tested over named credentials",
    "type":"object",
    "properties":{
        "count":{
            "type":"integer",
            "description":"The number of the different Global/Target instance tested over named credentials",
            "example":5
        },
        "items":{
            "type":"array",
            "description":"This is the list of different Global/Target instance tested over named credentials",
            "items":{
                "$ref":"#/components/schemas/NamedCredentialsTestResultsDetailsCollection"
            }
        }
    }
}

Nested Schema : items

Type: array

This is the list of different Global/Target instance tested over named credentials

Show Source

• Array of: object NamedCredentialsTestResultsDetailsCollection
  This represents the Result data of the named credentials tested

{
    "type":"array",
    "description":"This is the list of different Global/Target instance tested over named credentials",
    "items":{
        "$ref":"#/components/schemas/NamedCredentialsTestResultsDetailsCollection"
    }
}

Nested Schema : NamedCredentialsTestResultsDetailsCollection

Type: object

This represents the Result data of the named credentials tested

Show Source

• authenticationTestTargetName: string
  Test target name

  Example: server1.example.com
• authenticationTestTargetTypeName: string
  Name of the test target type

  Example: host
• count: integer
  The number of the different named credentials blocks tested separated by global/target instance

  Example: 10
• namedCredentialsTestResponseCollection: array namedCredentialsTestResponseCollection
  Collection of Named credentials names and its results

{
    "description":"This represents the Result data of the named credentials tested",
    "type":"object",
    "properties":{
        "count":{
            "type":"integer",
            "description":"The number of the different named credentials blocks tested separated by global/target instance",
            "example":10
        },
        "authenticationTestTargetName":{
            "type":"string",
            "description":"Test target name",
            "example":"server1.example.com"
        },
        "authenticationTestTargetTypeName":{
            "type":"string",
            "description":"Name of the test target type",
            "example":"host"
        },
        "namedCredentialsTestResponseCollection":{
            "type":"array",
            "description":"Collection of Named credentials names and its results",
            "items":{
                "$ref":"#/components/schemas/NamedCredentialsTestResult"
            }
        }
    }
}

Nested Schema : namedCredentialsTestResponseCollection

Type: array

Collection of Named credentials names and its results

Show Source

• Array of: object NamedCredentialsTestResult
  This represents the Result data of the named credentials tested

{
    "type":"array",
    "description":"Collection of Named credentials names and its results",
    "items":{
        "$ref":"#/components/schemas/NamedCredentialsTestResult"
    }
}

Nested Schema : NamedCredentialsTestResult

Type: object

This represents the Result data of the named credentials tested

Show Source

• credentialName: string
  Name for a named credential

  Example: NAMEDCRED1
• errorMessage: string
  Error message when named credential test is unsuccessful.

  Example: Authentication failure, check credential properties
• isPassed: boolean
  True if test was successful. False otherwise

  Example: true

{
    "description":"This represents the Result data of the named credentials tested",
    "type":"object",
    "properties":{
        "credentialName":{
            "type":"string",
            "description":"Name for a named credential",
            "example":"NAMEDCRED1"
        },
        "isPassed":{
            "type":"boolean",
            "description":"True if test was successful. False otherwise",
            "example":true
        },
        "errorMessage":{
            "type":"string",
            "description":"Error message when named credential test is unsuccessful.",
            "example":"Authentication failure, check credential properties"
        }
    }
}

Examples

Select an example Response 1 Response 2 Response 3

400 Response

Bad Request

Body ()

Root Schema : ErrorResponse

Type: object

Response sent back in the case of an Error

Show Source

• code(required): string
  The status code of the error
• message(required): string
  A descriptive error message

{
    "required":[
        "code",
        "message"
    ],
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"The status code of the error"
        },
        "message":{
            "type":"string",
            "description":"A descriptive error message"
        }
    },
    "description":"Response sent back in the case of an Error"
}

401 Response

Unauthorized

Body ()

Root Schema : ErrorResponse

Type: object

Response sent back in the case of an Error

Show Source

• code(required): string
  The status code of the error
• message(required): string
  A descriptive error message

{
    "required":[
        "code",
        "message"
    ],
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"The status code of the error"
        },
        "message":{
            "type":"string",
            "description":"A descriptive error message"
        }
    },
    "description":"Response sent back in the case of an Error"
}

403 Response

Forbidden

Body ()

Root Schema : MissingPrivErrorResponse

Type: object

Response sent back as an Error in case required privileges are missing

Show Source

• missingPrivileges: array missingPrivileges
  Privileges which are missing due to that the Error is occurred. This will have privilege internal name and display name only in the Privilege object

{
    "type":"object",
    "properties":{
        "missingPrivileges":{
            "type":"array",
            "description":"Privileges which are missing due to that the Error is occurred. This will have privilege internal name and display name only in the Privilege object",
            "items":{
                "$ref":"#/components/schemas/MissingPrivilegeSummary"
            }
        }
    },
    "description":"Response sent back as an Error in case required privileges are missing",
    "allOf":[
        {
            "$ref":"#/components/schemas/ErrorResponse"
        }
    ]
}

Match All

Response sent back as an Error in case required privileges are missing

Show Source

• object ErrorResponse
  Response sent back in the case of an Error

{
    "type":"object",
    "properties":{
        "missingPrivileges":{
            "type":"array",
            "description":"Privileges which are missing due to that the Error is occurred. This will have privilege internal name and display name only in the Privilege object",
            "items":{
                "$ref":"#/components/schemas/MissingPrivilegeSummary"
            }
        }
    },
    "description":"Response sent back as an Error in case required privileges are missing",
    "allOf":[
        {
            "$ref":"#/components/schemas/ErrorResponse"
        }
    ]
}

Nested Schema : missingPrivileges

Type: array

Privileges which are missing due to that the Error is occurred. This will have privilege internal name and display name only in the Privilege object

Show Source

• Array of: object MissingPrivilegeSummary
  It represents a Privilege which is missing on a Resource to view or manage it.

{
    "type":"array",
    "description":"Privileges which are missing due to that the Error is occurred. This will have privilege internal name and display name only in the Privilege object",
    "items":{
        "$ref":"#/components/schemas/MissingPrivilegeSummary"
    }
}

Nested Schema : ErrorResponse

Type: object

Response sent back in the case of an Error

Show Source

• code(required): string
  The status code of the error
• message(required): string
  A descriptive error message

{
    "required":[
        "code",
        "message"
    ],
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"The status code of the error"
        },
        "message":{
            "type":"string",
            "description":"A descriptive error message"
        }
    },
    "description":"Response sent back in the case of an Error"
}

Nested Schema : MissingPrivilegeSummary

Type: object

It represents a Privilege which is missing on a Resource to view or manage it.

Show Source

• displayName: string
  Display Name of Privilege

  Example: Manage
• name: string
  Name of Privilege

  Example: MANAGE_JOB

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"Name of Privilege",
            "example":"MANAGE_JOB"
        },
        "displayName":{
            "type":"string",
            "description":"Display Name of Privilege",
            "example":"Manage"
        }
    },
    "description":"It represents a Privilege which is missing on a Resource to view or manage it."
}

404 Response

Not Found

Body ()

Root Schema : ErrorResponse

Type: object

Response sent back in the case of an Error

Show Source

• code(required): string
  The status code of the error
• message(required): string
  A descriptive error message

{
    "required":[
        "code",
        "message"
    ],
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"The status code of the error"
        },
        "message":{
            "type":"string",
            "description":"A descriptive error message"
        }
    },
    "description":"Response sent back in the case of an Error"
}

500 Response

Internal Server Error

Body ()

Root Schema : ErrorResponse

Type: object

Response sent back in the case of an Error

Show Source

• code(required): string
  The status code of the error
• message(required): string
  A descriptive error message

{
    "required":[
        "code",
        "message"
    ],
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"The status code of the error"
        },
        "message":{
            "type":"string",
            "description":"A descriptive error message"
        }
    },
    "description":"Response sent back in the case of an Error"
}

Back to Top