Skip to content

Latest commit

 

History

History
29 lines (25 loc) · 2.5 KB

CreateAuthMethodEmail.md

File metadata and controls

29 lines (25 loc) · 2.5 KB

CreateAuthMethodEmail

createAuthMethodEmail is a command that creates a new auth method that will be able to authenticate using email. [Deprecated: Use auth-method-create-email command]

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]
email str An email address to be invited to have access
enable_mfa str Enable MFA for this authentication method [True / False] [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]
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]
mfa_type str Enable two-factor-authentication via [email/auth app] [optional] [default to 'email']
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]
token str Authentication token (see `/auth` and `/configure`) [optional]
uid_token str The universal identity token, Required only for universal_identity authentication [optional]

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