Skip to content

Latest commit

 

History

History
35 lines (31 loc) · 3.31 KB

Auth.md

File metadata and controls

35 lines (31 loc) · 3.31 KB

akeyless.Auth

Properties

Name Type Description Notes
accessId String Access ID [optional]
accessKey String Access key (relevant only for access-type=access_key) [optional]
accessType String Access Type (access_key/password/saml/ldap/k8s/azure_ad/oidc/aws_iam/universal_identity/jwt/gcp/cert) [optional] [default to 'access_key']
accountId String Account id (relevant only for access-type=password where the email address is associated with more than one account) [optional]
adminEmail String Email (relevant only for access-type=password) [optional]
adminPassword String Password (relevant only for access-type=password) [optional]
certData String Certificate data encoded in base64. Used if file was not provided. (relevant only for access-type=cert) [optional]
cloudId String The cloud identity (relevant only for access-type=azure_ad,aws_iam,gcp) [optional]
debug Boolean [optional]
disablePafxfast String Disable the FAST negotiation in the Kerberos authentication method [optional]
gatewaySpn String The service principal name of the gateway as registered in LDAP (i.e., HTTP/gateway) [optional]
gatewayUrl String Gateway URL relevant only for access-type=k8s/oauth2/saml/oidc [optional]
gcpAudience String GCP JWT audience [optional] [default to 'akeyless.io']
json Boolean Set output format to JSON [optional] [default to false]
jwt String The Json Web Token (relevant only for access-type=jwt/oidc) [optional]
k8sAuthConfigName String The K8S Auth config name (relevant only for access-type=k8s) [optional]
k8sServiceAccountToken String The K8S service account token. (relevant only for access-type=k8s) [optional]
kerberosUsername String TThe username for the entry within the keytab to authenticate via Kerberos [optional]
keyData String Private key data encoded in base64. Used if file was not provided.(relevant only for access-type=cert) [optional]
keytabData String Base64-encoded content of a valid keytab file, containing the service account's entry. [optional]
krb5ConfData String Base64-encoded content of a valid krb5.conf file, specifying the settings and parameters required for Kerberos authentication. [optional]
ldapPassword String LDAP password (relevant only for access-type=ldap) [optional]
ldapUsername String LDAP username (relevant only for access-type=ldap) [optional]
ociAuthType String The type of the OCI configuration to use [instance/apikey/resource] (relevant only for access-type=oci) [optional] [default to 'apikey']
ociGroupOcid [String] A list of Oracle Cloud IDs groups (relevant only for access-type=oci) [optional]
uidToken String The universal_identity token (relevant only for access-type=universal_identity) [optional]
useRemoteBrowser Boolean Returns a link to complete the authentication remotely (relevant only for access-type=saml/oidc) [optional]