Skip to content

Latest commit

 

History

History
66 lines (60 loc) · 3.85 KB

CreateAuthMethodAWSIAM.md

File metadata and controls

66 lines (60 loc) · 3.85 KB

Akeyless::CreateAuthMethodAWSIAM

Properties

Name Type Description Notes
access_expires Integer Access expiration date in Unix timestamp (select 0 for access without expiry date) [optional][default to 0]
allowed_client_type Array<String> limit the auth method usage for specific client types [cli,ui,gateway-admin,sdk,mobile,extension] [optional]
audit_logs_claims Array<String> Subclaims to include in audit logs, e.g &quot;--audit-logs-claims email --audit-logs-claims username&quot; [optional]
bound_arn Array<String> A list of full arns that the access is restricted to [optional]
bound_aws_account_id Array<String> A list of AWS account-IDs that the access is restricted to
bound_ips Array<String> A CIDR whitelist with the IPs that the access is restricted to [optional]
bound_resource_id Array<String> A list of full resource ids that the access is restricted to [optional]
bound_role_id Array<String> A list of full role ids that the access is restricted to [optional]
bound_role_name Array<String> A list of full role-name that the access is restricted to [optional]
bound_user_id Array<String> A list of full user ids that the access is restricted to [optional]
bound_user_name Array<String> A list of full user-name that the access is restricted to [optional]
delete_protection String Protection from accidental deletion of this object [true/false] [optional]
description String Auth Method description [optional]
expiration_event_in Array<String> How many days before the expiration of the auth method would you like to be notified. [optional]
force_sub_claims Boolean if true: enforce role-association must include sub claims [optional]
gw_bound_ips Array<String> A CIDR whitelist with the GW IPs that the access is restricted to [optional]
json Boolean Set output format to JSON [optional][default to false]
jwt_ttl Integer Jwt TTL [optional][default to 0]
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]
product_type Array<String> Choose the relevant product type for the auth method [sm, sra, pm, dp, ca, ara] [optional]
sts_url String sts URL [optional][default to 'https://sts.amazonaws.com']
token String Authentication token (see `/auth` and `/configure`) [optional]
uid_token String The universal identity token, Required only for universal_identity authentication [optional]
unique_identifier 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]

Example

require 'akeyless'

instance = Akeyless::CreateAuthMethodAWSIAM.new(
  access_expires: null,
  allowed_client_type: null,
  audit_logs_claims: null,
  bound_arn: null,
  bound_aws_account_id: null,
  bound_ips: null,
  bound_resource_id: null,
  bound_role_id: null,
  bound_role_name: null,
  bound_user_id: null,
  bound_user_name: null,
  delete_protection: null,
  description: null,
  expiration_event_in: null,
  force_sub_claims: null,
  gw_bound_ips: null,
  json: null,
  jwt_ttl: null,
  name: null,
  owner: null,
  product_type: null,
  sts_url: null,
  token: null,
  uid_token: null,
  unique_identifier: null
)