The POST /CertificateAuthority/TaskQueue/Test method is used test the connectivity to the RabbitMQ instance using the task queue settings configured in Keyfactor Command. This method returns HTTP 200 OK on a success with success or fail and a message with more information, if applicable.
Table 300: PUT Certificate Authority Task Queue Test Input Body
|
Name |
In |
Description |
|---|---|---|
| TaskQueueURL | Body |
Required. The amqp or amqps URL to the RabbitMQ instance. For example:
amqps://appsrvr12.keyexample.com
|
|
TokenURL |
Body |
Required in some cases. A string indicating the bearer token URL. This is the URL of the token endpoint for your identity provider instance. This field is required if OAuth authentication is used. |
| ClientID | Body |
Required in some cases. A string indicating the client ID used to authenticate to RabbitMQ, if OAuth authentication is selected. This field is required if OAuth authentication is used. |
| ClientSecret |
Body |
Required in some cases. An object indicating the client secret information to use for authentication along with the ClientID to make the connection to RabbitMQ, if OAuth authentication is selected. Supported methods to store secret information are:
Due to its sensitive nature, this value is not returned in responses. This field is required if OAuth authentication is used. |
| Scope | Body | A string indicating any scopes that should be included in token requests to the identity provider, if OAuth authentication is selected. If multiple scopes are desired, they should be separated by spaces. |
| Username |
Body |
Required in some cases. A string indicating the username used to authenticate to RabbitMQ, if Basic authentication is selected. This field is required if Basic authentication is used. |
| Audience | Body | A string indicating the audience that should be included in token requests to the identity provider, if OAuth authentication is selected. |
| Password |
Body |
Required in some cases. An object indicating the password information to use for authentication along with the Username to make the connection to RabbitMQ, if Basic authentication is selected. Supported methods to store secret information are:
Due to its sensitive nature, this value is not returned in responses. This field is required if Basic authentication is used. |
| AuthType | Body | Required. A string indicating the type of authentication used to make the connection to RabbitMQ. Supported values are Basic or OAuth. |
Table 301: POST Certificate Authority Task Queue Test Response Body
|
Name |
Description |
|---|---|
| Success |
A Boolean that indicates whether the connection to RabbitMQ from Keyfactor Command could successfully be made (true) or not (false). |
|
Message |
A string indicating a message about the validation test of the task queue configuration. |
An API is a set of functions to allow creation of applications. Keyfactor offers the Keyfactor API, which allows third-party software to integrate with the advanced certificate enrollment and management features of Keyfactor Command. endpoints can be called and results returned. It is intended to be used primarily for validation, testing and workflow A workflow is a series of steps necessary to complete a process. In Keyfactor Command, it refers to the workflow builder, which allows you to automate event-driven tasks such as when a certificate is requested, revoked or found in a certificate store. development. It also serves secondarily as documentation for the API. The link to the Keyfactor API Reference and Utility is in the dropdown from the help icon (
) at the top of the Management Portal page next to the Log Out button.