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
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
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
Nested Schema : TestCredentialCriteria
Type:
object
This consists of data required to test a named credential
Show Source
-
authenticationTestTargetName: string
Test target nameExample:
testhost.example.com
-
authenticationTestTargetTypeName: string
Name of the test target typeExample:
host
-
credentialNameAndOwnerCollection(required): array
credentialNameAndOwnerCollection
Credential name list
Nested Schema : credentialNameAndOwnerCollection
Type:
array
Credential name list
Show Source
-
Array of:
object CredentialNameAndOwnerCollection
Credential name and owner for named credential to test
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 userExample:
ADMIN1
Nested Schema : credNames
Type:
array
List of Named credentials for a particular owner
Show Source
-
Array of:
string
Example:
NAMEDCRED1, NAMEDCRED2
Examples
Back to Top
Response
Supported Media Types
- application/json
200 Response
Named credentials test information is given successfully
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 credentialsExample:
5
-
items: array
items
This is the list of different Global/Target instance tested over named credentials
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
Nested Schema : NamedCredentialsTestResultsDetailsCollection
Type:
object
This represents the Result data of the named credentials tested
Show Source
-
authenticationTestTargetName: string
Test target nameExample:
server1.example.com
-
authenticationTestTargetTypeName: string
Name of the test target typeExample:
host
-
count: integer
The number of the different named credentials blocks tested separated by global/target instanceExample:
10
-
namedCredentialsTestResponseCollection: array
namedCredentialsTestResponseCollection
Collection of Named credentials names and its results
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
Nested Schema : NamedCredentialsTestResult
Type:
object
This represents the Result data of the named credentials tested
Show Source
-
credentialName: string
Name for a named credentialExample:
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 otherwiseExample:
true
Examples
400 Response
Bad Request. The payload is null or missing some parameters
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
401 Response
Unauthorized. The user does not have permissions to perform the requested operation
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
403 Response
Forbidden. The user is forbidden to perform the requested operation
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
404 Response
Not Found. The requested REST API URL is not found.
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
500 Response
Internal Server Error. Exception in execution of REST API.
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