Home

Documentation for Conjur

Documentation for API Endpoints

All URIs are relative to https://conjur

Class	Method	HTTP request	Description
AuthnApi	authenticate	POST /{authenticator}/{account}/{login}/authenticate	Gets a short-lived access token, which can be used to authenticate requests to (most of) the rest of the Conjur API.
AuthnApi	authenticateService	POST /{authenticator}/{service_id}/{account}/{login}/authenticate	Gets a short-lived access token, which can be used to authenticate requests to (most of) the rest of the Conjur API.
AuthnApi	login	GET /{authenticator}/{account}/login	Gets the API key of a user given the username and password via HTTP Basic Authentication.
AuthnApi	rotateApiKey	PUT /{authenticator}/{account}/api_key	Rotates a user’s API key.
AuthnApi	serviceLogin	GET /{authenticator}/{service_id}/{account}/login	Login with the given authenticator
AuthnApi	setPassword	PUT /authn/{account}/password	Changes a user’s password.
AuthnApi	updateAuthenticatorConfig	PATCH /{authenticator}/{service_id}/{account}	Updates the authenticators configuration
CertificateAuthorityApi	sign	POST /ca/{account}/{service_id}/sign	Gets a signed certificate from the configured Certificate Authority service.
HostFactoryApi	createHost	POST /host_factories/hosts	Creates a Host using the Host Factory.
HostFactoryApi	createHostToken	POST /host_factory_tokens	Creates one or more host identity tokens.
HostFactoryApi	revokeHostToken	DELETE /host_factory_tokens/{token}	Revokes a token, immediately disabling it.
PoliciesApi	loadPolicy	PUT /policies/{account}/policy/{identifier}	Loads or replaces a Conjur policy document.
PoliciesApi	modifyPolicy	PATCH /policies/{account}/policy/{identifier}	Modifies an existing Conjur policy.
PoliciesApi	updatePolicy	POST /policies/{account}/policy/{identifier}	Adds data to the existing Conjur policy.
PublicKeysApi	showPublicKeys	GET /public_keys/{account}/{kind}/{identifier}	Shows all public keys for a resource.
ResourcesApi	getResource	GET /resources/{account}/{kind}/{identifier}	Shows a description of a single resource.
ResourcesApi	getResources	GET /resources	Lists resources within an organization account.
ResourcesApi	getResourcesOnAccount	GET /resources/{account}	Lists resources within an organization account.
ResourcesApi	getSimilarResourcesOnAccount	GET /resources/{account}/{kind}	Lists resources of the same kind within an organization account.
RolesApi	addMember	POST /roles/{account}/{kind}/{identifier}	Update or modify an existing role membership
RolesApi	deleteMember	DELETE /roles/{account}/{kind}/{identifier}	Deletes an existing role membership
RolesApi	getRole	GET /roles/{account}/{kind}/{identifier}	Get role information
SecretsApi	createVariable	POST /secrets/{account}/{kind}/{identifier}	Creates a secret value within the specified variable.
SecretsApi	getVariable	GET /secrets/{account}/{kind}/{identifier}	Fetches the value of a secret from the specified Variable.
SecretsApi	getVariables	GET /secrets	Fetch multiple secrets
StatusApi	authenticatorServiceStatus	GET /authn-{authenticator}/{service_id}/{account}/status	Details whether an authentication service has been configured properly
StatusApi	authenticatorStatus	GET /authn-{authenticator}/{account}/status	Details whether an authentication service has been configured properly
StatusApi	authenticatorsIndex	GET /authenticators	Details about which authenticators are on the Conjur Server
StatusApi	whoAmI	GET /whoami	Provides information about the client making an API request.

Documentation for Models

• AuthenticatorStatus
• Authenticators
• AuthenticatorsResponse
• CertificateJson
• CreateHostRequest
• CsrBody
• ExternalAuthenticators
• HostFactoryTokenRequest
• InlineObject
• WhoAmI

Documentation for Authorization

basicAuth

• Type: HTTP basic authentication

conjurAuth

• Type: API key
• API key parameter name: Authorization
• Location: HTTP header