Skip to content

UpdateAuthMethodOAuth2.md

Latest commit

 

History

History
39 lines (31 loc) · 3.74 KB

UpdateAuthMethodOAuth2.md

File metadata and controls

39 lines (31 loc) · 3.74 KB

UpdateAuthMethodOAuth2

updateAuthMethodOAuth2 is a command that updates a new auth method that will be able to authenticate using Oauth2. [Deprecated: Use auth-method-update-oauth2 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]
audience String The audience in the JWT [optional]
auditLogsClaims List<String> Subclaims to include in audit logs, e.g &quot;--audit-logs-claims email --audit-logs-claims username&quot; [optional]
boundClientIds List<String> The clients ids that the access is restricted to [optional]
boundIps List<String> A CIDR whitelist with the IPs that the access is restricted to [optional]
cert String CertificateFile Path to a file that contain the certificate in a PEM format. [optional]
certFileData String CertificateFileData PEM Certificate in a Base64 format. [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]
gatewayUrl String Akeyless Gateway URL (Configuration Management port). Relevant only when the jwks-uri is accessible only from the gateway. [optional]
gwBoundIps List<String> A CIDR whitelist with the GW IPs that the access is restricted to [optional]
issuer String Issuer URL [optional]
json Boolean Set output format to JSON [optional]
jwksJsonData String The JSON Web Key Set (JWKS) that containing the public keys that should be used to verify any JSON Web Token (JWT) issued by the authorization server. base64 encoded string [optional]
jwksUri String The URL to the JSON Web Key Set (JWKS) that containing the public keys that should be used to verify any JSON Web Token (JWT) issued by the authorization server. [optional]
jwtTtl Long Jwt TTL [optional]
name String Auth Method name
newName String Auth Method new name [optional]
productType List<String> Choose the relevant product type for the auth method [sm, sra, pm, dp, ca] [optional]
subclaimsDelimiters List<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 &quot;sub claim&quot; 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.