keyfactor-auth-client-go

command module

v0.0.1-rc.4 Latest Latest Go to latest Published: Sep 3, 2024 License: Apache-2.0 Imports: 2 Imported by: 0

Details

Client library for authenticating to Keyfactor Command

Name	Description	Default
KEYFACTOR_HOSTNAME	Keyfactor Command hostname without protocol and port
KEYFACTOR_PORT	Keyfactor Command port	`443`
KEYFACTOR_API_PATH	Keyfactor Command API Path	`KeyfactorAPI`
KEYFACTOR_SKIP_VERIFY	Skip TLS verification when connecting to Keyfactor Command	`false`
KEYFACTOR_CA_CERT	Either a file path or PEM encoded string to a CA certificate

Name	Description	Default
KEYFACTOR_USERNAME	Active Directory username to authenticate to Keyfactor Command API
KEYFACTOR_PASSWORD	Password associated with Active Directory username to authenticate to Keyfactor Command API
KEYFACTOR_DOMAIN	Active Directory domain of user. Can be implied from username if it contains `@` or `\\`

Name	Description	Default
KEYFACTOR_AUTH_HOSTNAME	Hostname of Keycloak instance to authenticate to Keyfactor Command
KEYFACTOR_AUTH_REALM	Keyfactor Auth Realm	`Keyfactor`
KEYFACTOR_AUTH_SCOPES	Scopes to request when authenticating to Keyfactor Command API	`openid`
KEYFACTOR_ACCESS_TOKEN	Access token to use to authenticate to Keyfactor Command API. This can be supplied directly or generated via client credentials
KEYFACTOR_AUTH_CA_CERT	Either a file path or PEM encoded string to a CA certificate to use when connecting to Keyfactor Auth

Name	Description	Default
KEYFACTOR_AUTH_CLIENT_ID	Keyfactor Auth Client ID
KEYFACTOR_AUTH_CLIENT_SECRET	Keyfactor Auth Client Secret

These environment variables are used to run go tests. They are not used in the actual client library.

Name	Description	Default
TEST_KEYFACTOR_AD_AUTH	Set to `true` to test Active Directory authentication	false
TEST_KEYFACTOR_KC_AUTH	Set to `true` to test Keycloak authentication	false

There is no documentation for this package.