Authentication

POST /update-auth-method-aws-iam

Request

  • Base URL
    https://api.akeyless.io
  • URL
    https://api.akeyless.io/update-auth-method-aws-iam
  • Auth
    none declared

Request body

access-expiresinteger

Access expiration date in Unix timestamp (select 0 for access without expiry date)

allowed-client-typestring[]

limit the auth method usage for specific client types [cli,ui,gateway-admin,sdk,mobile,extension]

audit-logs-claimsstring[]

Subclaims to include in audit logs, e.g "--audit-logs-claims email --audit-logs-claims username"

bound-arnstring[]

A list of full arns that the access is restricted to

bound-aws-account-idstring[] required

A list of AWS account-IDs that the access is restricted to

bound-ipsstring[]

A CIDR whitelist with the IPs that the access is restricted to

bound-resource-idstring[]

A list of full resource ids that the access is restricted to

bound-role-idstring[]

A list of full role ids that the access is restricted to

bound-role-namestring[]

A list of full role-name that the access is restricted to

bound-user-idstring[]

A list of full user ids that the access is restricted to

bound-user-namestring[]

A list of full user-name that the access is restricted to

delete_protectionstring

Protection from accidental deletion of this object [true/false]

descriptionstring

Auth Method description

expiration-event-instring[]

How many days before the expiration of the auth method would you like to be notified.

force-sub-claimsboolean

if true: enforce role-association must include sub claims

gw-bound-ipsstring[]

A CIDR whitelist with the GW IPs that the access is restricted to

jsonboolean

Set output format to JSON

jwt-ttlinteger

Jwt TTL

namestring required

Auth Method name

new-namestring

Auth Method new name

product-typestring[]

Choose the relevant product type for the auth method [sm, sra, pm, dp, ca, ara]

sts-urlstring

sts URL

tokenstring

Authentication token (see /auth and /configure)

uid-tokenstring

The universal identity token, Required only for universal_identity authentication

unique-identifierstring

A unique identifier (ID) value which is a "sub claim" name that contains details uniquely identifying that resource. This "sub claim" is used to distinguish between different identities.

Response

updateAuthMethodAWSIAMResponse wraps response body.

UpdateAuthMethodAWSIAMOutput required

Changes

No recorded changes to this operation across all 1 revision of this API.