Skip to content

Latest commit

 

History

History
32 lines (24 loc) · 2.41 KB

CreateAuthMethodEmail.md

File metadata and controls

32 lines (24 loc) · 2.41 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
accessExpires Long Access expiration date in Unix timestamp (select 0 for access without expiry date) [optional]
allowedClientType List<String> limit the auth method usage for specific client types [cli,ui,gateway-admin,sdk,mobile,extension] [optional]
auditLogsClaims List<String> Subclaims to include in audit logs, e.g &quot;--audit-logs-claims email --audit-logs-claims username&quot; [optional]
boundIps List<String> A CIDR whitelist with the IPs that the access is restricted to [optional]
deleteProtection String Protection from accidental deletion of this object [true/false] [optional]
description String Auth Method description [optional]
email String An email address to be invited to have access
enableMfa String Enable MFA for this authentication method [True / False] [optional]
expirationEventIn List<String> How many days before the expiration of the auth method would you like to be notified. [optional]
forceSubClaims Boolean if true: enforce role-association must include sub claims [optional]
gwBoundIps List<String> A CIDR whitelist with the GW IPs that the access is restricted to [optional]
json Boolean Set output format to JSON [optional]
jwtTtl Long Jwt TTL [optional]
mfaType String Enable two-factor-authentication via [email/auth app] [optional]
name String Auth Method name
owner String 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]
productType List<String> Choose the relevant product type for the auth method [sm, sra, pm, dp, ca, ara] [optional]
token String Authentication token (see `/auth` and `/configure`) [optional]
uidToken String The universal identity token, Required only for universal_identity authentication [optional]