Skip to content

Latest commit

 

History

History
29 lines (25 loc) · 3.03 KB

AuthMethodCreateLdap.md

File metadata and controls

29 lines (25 loc) · 3.03 KB

AuthMethodCreateLdap

authMethodCreateLdap is a command that creates a new auth method that will be able to authenticate using LDAP.

Properties

Name Type Description Notes
access_expires int Access expiration date in Unix timestamp (select 0 for access without expiry date) [optional] [default to 0]
allowed_client_type list[str] limit the auth method usage for specific client types [cli,ui,gateway-admin,sdk,mobile,extension] [optional]
audit_logs_claims list[str] Subclaims to include in audit logs, e.g "--audit-logs-claims email --audit-logs-claims username" [optional]
bound_ips list[str] A CIDR whitelist with the IPs that the access is restricted to [optional]
delete_protection str Protection from accidental deletion of this object [true/false] [optional]
description str Auth Method description [optional]
expiration_event_in list[str] How many days before the expiration of the auth method would you like to be notified. [optional]
force_sub_claims bool if true: enforce role-association must include sub claims [optional]
gen_key str Automatically generate key-pair for LDAP configuration. If set to false, a public key needs to be provided [true/false] [optional] [default to 'true']
gw_bound_ips list[str] A CIDR whitelist with the GW IPs that the access is restricted to [optional]
json bool Set output format to JSON [optional] [default to False]
jwt_ttl int Jwt TTL [optional] [default to 0]
name str Auth Method name
owner str Auth Method owner (free text, up to 255 characters). On update, omit to keep the current owner and pass an empty value to clear it [optional]
product_type list[str] Choose the relevant product type for the auth method [sm, sra, pm, dp, ca, ara] [optional]
public_key_data str A public key generated for LDAP authentication method on Akeyless in base64 or PEM format [RSA2048] [optional]
token str Authentication token (see `/auth` and `/configure`) [optional]
uid_token str The universal identity token, Required only for universal_identity authentication [optional]
unique_identifier str A unique identifier (ID) value should be configured for OAuth2, LDAP and SAML authentication method types and is usually a value such as the email, username, or upn for example. Whenever a user logs in with a token, these authentication types issue a "sub claim" that contains details uniquely identifying that user. This sub claim includes a key containing the ID value that you configured, and is used to distinguish between different users from within the same organization. [optional] [default to 'users']

[Back to Model list] [Back to API list] [Back to README]