{"@context": "https://schema.org", "@type": "WebAPI", "name": "Conjur API", "description": "This is an API definition for CyberArk Conjur Open Source. You can find out more at [Conjur.org](https://www.conjur.org/).", "provider": {"@type": "Organization", "name": "conjur.local"}, "documentation": "https://raw.githubusercontent.com/cyberark/conjur-openapi-spec/main/spec/openapi.yml"}
This is an API definition for CyberArk Conjur Open Source. You can find out more at [Conjur.org](https://www.conjur.org/).
Every row below was read from the vendor's own OpenAPI document. The summary text is theirs. What this registry adds is that each operation is indexed with its method, path, base URL and auth scheme, so a search for a capability can answer with a call rather than a name, and that the endpoint is probed on a schedule.
Specifications as held by the APIs.guru corpus, whose newest record is 2023-04-21. Operations the vendor has added since are not listed here; the origin links above are the vendor's own current documents.
base URLs: http://conjur.local
auth: a p i k e y
find it by capability: POST /search {"query":{"text":"..."}} returns these
operations with their invocation detail. Connect any agent client.
This is an API definition for CyberArk Conjur Open Source. You can find out more at [Conjur.org](https://www.conjur.org/).
| method | path | what the vendor says it does |
|---|---|---|
GET | /authenticators | Details about which authenticators are on the Conjur Server Response contains three members: installed, config |
POST | /authn-azure/{service_id}/{account}/{login}/authenticate | Gets a short-lived access token for applications running in Azure. The access token is used to communicate to |
POST | /authn-gcp/{account}/authenticate | Gets a short-lived access token for applications running in Google Cloud Platform. Use the GCP Authenticator A |
GET | /authn-gcp/{account}/status | Details whether an authentication service has been configured properly Once the status webservice has been pro |
POST | /authn-iam/{service_id}/{account}/{login}/authenticate | Get a short-lived access token for applications running in AWS. The access token is used to communicate to the |
POST | /authn-jwt/{service_id}/{account}/authenticate | Gets a short-lived access token for applications using JSON Web Token (JWT) to access the Conjur API. Use the |
POST | /authn-jwt/{service_id}/{account}/{id}/authenticate | Gets a short-lived access token for applications using JSON Web Token (JWT) to access the Conjur API. Covers t |
POST | /authn-k8s/{service_id}/inject_client_cert | For applications running in Kubernetes; sends Conjur a certificate signing request (CSR) and requests a client |
POST | /authn-k8s/{service_id}/{account}/{login}/authenticate | Gets a short-lived access token for applications running in Kubernetes. The access token is used to communicat |
GET | /authn-ldap/{service_id}/{account}/login | Gets the Conjur API key of a user given the LDAP username and password via HTTP Basic Authentication. Exchange |
POST | /authn-ldap/{service_id}/{account}/{login}/authenticate | Gets a short-lived access token for users and hosts using their LDAP identity to access the Conjur API. The ac |
POST | /authn-oidc/{service_id}/{account}/authenticate | Gets a short-lived access token for applications using OpenID Connect (OIDC) to access the Conjur API. Use the |
PUT | /authn/{account}/api_key | Rotates a role's API key. Any role can rotate its own API key. The name and password (for users) or current AP |
GET | /authn/{account}/login | Gets the API key of a user given the username and password via HTTP Basic Authentication. Passwords are stored |
PUT | /authn/{account}/password | Changes a user’s password. You must provide the login name and current password or API key of the user whose p |
POST | /authn/{account}/{login}/authenticate | Gets a short-lived access token, which is required in the header of most subsequent API requests. A client can |
POST | /ca/{account}/{service_id}/sign | Gets a signed certificate from the configured Certificate Authority service. Gets a signed certificate from th |
GET | /health | Health info about conjur You can request health checks against any cluster node using the Conjur API. These ro |
POST | /host_factories/hosts | Creates a Host using the Host Factory. Creates a Host using the Host Factory and returns a JSON description of |
POST | /host_factory_tokens | Creates one or more host identity tokens. Creates one or more tokens which can be used to bootstrap host ident |
DELETE | /host_factory_tokens/{token} | Revokes a token, immediately disabling it. Revokes a token, immediately disabling it. ##### Permissions requi |
GET | /info | Basic information about the Conjur Enterprise server Information about the Conjur Enterprise node which was qu |
POST | /policies/{account}/policy/{identifier} | Adds data to the existing Conjur policy. Adds data to the existing Conjur policy. Deletions are not allowed. A |
PUT | /policies/{account}/policy/{identifier} | Loads or replaces a Conjur policy document. Loads or replaces a Conjur policy document. **Any policy data whi |
PATCH | /policies/{account}/policy/{identifier} | Modifies an existing Conjur policy. Modifies an existing Conjur policy. Data may be explicitly deleted using t |
GET | /public_keys/{account}/{kind}/{identifier} | Shows all public keys for a resource. Shows all public keys for a resource as newline delimited string for com |
GET | /remote_health/{remote} | Health info about a given Conjur Enterprise server Use the remote_health route to check the health of any Conj |
GET | /resources | Lists resources within an organization account. Lists resources within an organization account. In the absenc |
GET | /resources/{account} | Lists resources within an organization account. Lists resources within an organization account. If a `kind` q |
GET | /resources/{account}/{kind} | Lists resources of the same kind within an organization account. Lists resources of the same kind within an or |
GET | /resources/{account}/{kind}/{identifier} | Shows a description of a single resource. Details about a single resource. If `permitted_roles` and `privileg |
GET | /roles/{account}/{kind}/{identifier} | Get role information Gets detailed information about a specific role, including the role members. If a role A |
POST | /roles/{account}/{kind}/{identifier} | Update or modify an existing role membership Updates or modifies an existing role membership. If a role A is |
DELETE | /roles/{account}/{kind}/{identifier} | Deletes an existing role membership Deletes an existing role membership. If a role A is granted to a role B, |
GET | /secrets | Fetch multiple secrets Fetches multiple secret values in one invocation. It’s faster to fetch secrets in batch |
GET | /secrets/{account}/{kind}/{identifier} | Fetches the value of a secret from the specified Secret. Fetches the value of a secret from the specified Secr |
POST | /secrets/{account}/{kind}/{identifier} | Creates a secret value within the specified variable. Creates a secret value within the specified Secret. No |
GET | /whoami | Provides information about the client making an API request. WhoAmI provides information about the client maki |
PATCH | /{authenticator}/{account} | Enables or disables authenticator defined without service_id. Allows you to either enable or disable a given a |
PATCH | /{authenticator}/{service_id}/{account} | Enables or disables authenticator service instances. Allows you to either enable or disable a given authentica |
and 1 more operation(s) in this specification, all searchable.
specification origin: https://raw.githubusercontent.com/cyberark/conjur-openapi-spec/main/spec/openapi.yml
nothing on this page is a rating, an endorsement or a claim about quality. Reachability is what our probes observed from one network; answering is a floor under usefulness, not a measure of it.