-
Notifications
You must be signed in to change notification settings - Fork 2
StatusApi
All URIs are relative to http://localhost
| Method | HTTP request | Description |
|---|---|---|
| authenticatorServiceStatus | GET /authn-{authenticator}/{service_id}/{account}/status | Details whether an authentication service has been configured properly |
| authenticatorStatus | GET /authn-{authenticator}/{account}/status | Details whether an authentication service has been configured properly |
| authenticatorsIndex | GET /authenticators | Details about which authenticators are on the Conjur Server |
| whoAmI | GET /whoami | Provides information about the client making an API request. |
AuthenticatorStatus authenticatorServiceStatus(authenticator, serviceId, account)
Details whether an authentication service has been configured properly
Once the status webservice has been properly configured and the relevant user groups have been given permissions to access the status webservice, the users in those groups can check the status of the authenticator.
| Name | Type | Description | Notes |
|---|---|---|---|
| authenticator | String | The type of authenticator | [default to null] |
| serviceId | String | The ID of the authenticator provider | [default to null] |
| account | String | The organization account name | [default to null] |
- Content-Type: Not defined
- Accept: application/json
AuthenticatorStatus authenticatorStatus(authenticator, account)
Details whether an authentication service has been configured properly
Once the status webservice has been properly configured and the relevant user groups have been given permissions to access the status webservice, the users in those groups can check the status of the authenticator.
| Name | Type | Description | Notes |
|---|---|---|---|
| authenticator | String | The type of authenticator | [default to null] [enum: oidc, azure] |
| account | String | The organization account name | [default to null] |
- Content-Type: Not defined
- Accept: application/json
AuthenticatorsResponse authenticatorsIndex()
Details about which authenticators are on the Conjur Server
"Response contains three members: installed, configured, and enabled. installed: The authenticator is implemented in Conjur and is available for configuration configured: The authenticator has a webservice in the DB that was loaded by policy enabled: The authenticator is enabled (in the DB or in the ENV) and is ready for authentication "
This endpoint does not need any parameter.
basicAuth, conjurAuth, conjurKubernetesMutualTls
- Content-Type: Not defined
- Accept: application/json
WhoAmI whoAmI()
Provides information about the client making an API request.
WhoAmI provides information about the client making an API request. It can be used to help troubleshoot configuration by verifying authentication and the client IP address for audit and network access restrictions. For more information, see Host Attributes.
This endpoint does not need any parameter.
- Content-Type: Not defined
- Accept: application/json