Note: this component is designated "advanced", which means that objects of this type are not expected to be created or altered in most environments. If you believe that such a change is necessary, you may want to contact support in order to understand the potential impact of that change.
API Key Conjur Authentication Methods authenticate to a CyberArk instance with an API key to obtain an access token.
The API key may be provided directly, or you may provide a password for the target user that can be used to log into the Conjur server to obtain the API key.
The API Key Conjur Authentication Method component inherits from the Conjur Authentication Method
The properties supported by this managed object are as follows:
| Basic Properties: | Advanced Properties: |
|---|---|
| description | None |
| username | |
| password | |
| api-key |
| Description | A description for this Conjur Authentication Method |
| Default Value | None |
| Allowed Values | A string |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
| Description | The username for the user to authenticate. |
| Default Value | None |
| Allowed Values | A string |
| Multi-Valued | No |
| Required | Yes |
| Admin Action Required | None. Modification requires no further action |
| Description | The password for the user to authenticate. This will be used to obtain an API key for the target user. Exactly one of the password or the API key must be specified. |
| Default Value | None |
| Allowed Values | A string |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
| Description | The API key for the user to authenticate. Exactly one of the password or the API key must be specified. |
| Default Value | None |
| Allowed Values | A string |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
To list the configured Conjur Authentication Methods:
dsconfig list-conjur-authentication-methods
[--property {propertyName}] ...
To view the configuration for an existing Conjur Authentication Method:
dsconfig get-conjur-authentication-method-prop
--method-name {name}
[--tab-delimited]
[--script-friendly]
[--property {propertyName}] ...
To update the configuration for an existing Conjur Authentication Method:
dsconfig set-conjur-authentication-method-prop
--method-name {name}
(--set|--add|--remove) {propertyName}:{propertyValue}
[(--set|--add|--remove) {propertyName}:{propertyValue}] ...
To create a new API Key Conjur Authentication Method:
dsconfig create-conjur-authentication-method
--method-name {name}
--type api-key
--set username:{propertyValue}
[--set {propertyName}:{propertyValue}] ...
To delete an existing Conjur Authentication Method:
dsconfig delete-conjur-authentication-method
--method-name {name}