GET Certificate Authority Task Queue

The GET /CertificateAuthority/TaskQueue method is used to retrieve the details of the configuration for the task queue in Keyfactor Command. This method returns HTTP 200 OK on a success with the task queue settings. This method has no input parameters other than the standard headers (see Endpoint Common Features).

Tip:  The following permissions (see Security Roles and Claims) are required to use this feature:

/certificate_authorities/read/

Table 342: GET Certificate Authority Task Queue Response Body

Name

Description
TaskQueueURL

The amqp or amqps URL to the RabbitMQ instance. For example:

amqps://appsrvr12.keyexample.com

TokenURL

A string indicating the bearer token URL. This is the URL of the token endpoint for your identity provider instance.
ClientID

A string indicating the client ID used to authenticate to RabbitMQ, if OAuth authentication is selected.
ClientSecret

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:

  • Keyfactor: Store the secret information in the Keyfactor secrets table.

    A Keyfactor secret is a user-defined username or password that is encrypted and stored securely in the Keyfactor Command database.

  • PAM Provider: Load the secret information from a PAM provider.

    See Privileged Access Management (PAM) for more information.

Due to its sensitive nature, this value is not returned in responses.
Scope 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

A string indicating the username used to authenticate to RabbitMQ, if Basic authentication is selected.
Audience A string indicating the audience that should be included in token requests to the identity provider, if OAuth authentication is selected.
Password

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:

  • Keyfactor: Store the secret information in the Keyfactor secrets table.

    A Keyfactor secret is a user-defined username or password that is encrypted and stored securely in the Keyfactor Command database.

  • PAM Provider: Load the secret information from a PAM provider.

    See Privileged Access Management (PAM) for more information.

Due to its sensitive nature, this value is not returned in responses.
AuthType A string indicating the type of authentication used to make the connection to RabbitMQ. Supported values are Basic or OAuth.
Tip:  See the Keyfactor API Reference and Utility which provides a utility through which the Keyfactor APIClosed 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 workflowClosed 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.