Skip to content

UpdateAuthMethodSAML.md

Latest commit

 

History

History
29 lines (25 loc) · 2.7 KB

UpdateAuthMethodSAML.md

File metadata and controls

29 lines (25 loc) · 2.7 KB

akeyless.UpdateAuthMethodSAML

Properties

Name Type Description Notes
accessExpires Number Access expiration date in Unix timestamp (select 0 for access without expiry date) [optional] [default to 0]
allowedClientType [String] limit the auth method usage for specific client types [cli,ui,gateway-admin,sdk,mobile,extension] [optional]
allowedRedirectUri [String] Allowed redirect URIs after the authentication [optional]
auditLogsClaims [String] Subclaims to include in audit logs, e.g "--audit-logs-claims email --audit-logs-claims username" [optional]
boundIps [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]
expirationEventIn [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 [String] A CIDR whitelist with the GW IPs that the access is restricted to [optional]
idpMetadataUrl String IDP metadata url [optional]
idpMetadataXmlData String IDP metadata xml data [optional]
json Boolean Set output format to JSON [optional] [default to false]
jwtTtl Number Jwt TTL [optional] [default to 0]
name String Auth Method name
newName String Auth Method new name [optional]
productType [String] Choose the relevant product type for the auth method [sm, sra, pm, dp, ca] [optional]
subclaimsDelimiters [String] A list of additional sub claims delimiters (relevant only for SAML, OIDC, OAuth2/JWT) [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 should be configured for OAuth2, LDAP and SAML authentication method types and is usually a value such as the email, username, or upn for example. Whenever a user logs in with a token, these authentication types issue a "sub claim" that contains details uniquely identifying that user. This sub claim includes a key containing the ID value that you configured, and is used to distinguish between different users from within the same organization.