Skip to main content
GET
List credential status by system
credential_status can be:not exists: Not registeredactive: Registered and activeinactive: The credential failed to log in to the court (invalid or expired password, blocked user or expired certificate). Revalidate the login in the court portal and register the credential again to make it active.If a registration is created under the system * (generic registration), that credential will be used for every court that does not have its own specific registration in the same customer_key — so be careful with this type of registration.
Without the customer_key parameter (or with ?customer_key=*), the response lists every system available in the vault, with the status of each one under the default key * (use this list to copy the exact system_name). The example above is shortened. How to read the example without customer_key:
  • Row "name": "*" with "customer_key": "": this is the wildcard credential of the default key. The customer_key is empty because no wildcard is registered under that key (not exists). When one exists, it is filled in.
  • Other rows with "customer_key": "*": the API repeats the default key used as the filter, even when the status is not exists. This * is not a registered wildcard credential.
With ?customer_key=..., the "name": "*" row is the wildcard of that key and the other rows are only the systems with their own credential under it. If no customer_key is provided at registration, the default value * is used; the default key is never empty.

Authorizations

api-key
string
header
required

API key for authentication

Query Parameters

customer_key
string

Credential key defined at registration. Defaults to *.

Response

200 - application/json

List of systems with their credential status

systems
object[]