Skip to content

Latest commit

 

History

History
38 lines (30 loc) · 3.27 KB

CreateAuthMethodAWSIAM.md

File metadata and controls

38 lines (30 loc) · 3.27 KB

CreateAuthMethodAWSIAM

createAuthMethodAWSIAM is a command that creates a new Auth Method that will be able to authenticate using AWS IAM credentials. [Deprecated: Use auth-method-create-aws-iam 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]
boundArn List<String> A list of full arns that the access is restricted to [optional]
boundAwsAccountId List<String> A list of AWS account-IDs that the access is restricted to
boundIps List<String> A CIDR whitelist with the IPs that the access is restricted to [optional]
boundResourceId List<String> A list of full resource ids that the access is restricted to [optional]
boundRoleId List<String> A list of full role ids that the access is restricted to [optional]
boundRoleName List<String> A list of full role-name that the access is restricted to [optional]
boundUserId List<String> A list of full user ids that the access is restricted to [optional]
boundUserName List<String> A list of full user-name 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]
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]
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]
stsUrl String sts URL [optional]
token String Authentication token (see `/auth` and `/configure`) [optional]
uidToken String The universal identity token, Required only for universal_identity authentication [optional]
uniqueIdentifier String A unique identifier (ID) value which is a &quot;sub claim&quot; name that contains details uniquely identifying that resource. This &quot;sub claim&quot; is used to distinguish between different identities. [optional]