Skip to content

Latest commit

 

History

History
33 lines (29 loc) · 3.4 KB

UpdateAuthMethodOIDC.md

File metadata and controls

33 lines (29 loc) · 3.4 KB
Raw

akeyless.Model.UpdateAuthMethodOIDC

updateAuthMethodOIDC is a command that updates a new auth method that will be available to authenticate using OIDC. [Deprecated: Use auth-method-update-oidc command]

Properties

Name Type Description Notes
AccessExpires long Access expiration date in Unix timestamp (select 0 for access without expiry date) [optional] [default to 0]
AllowedRedirectUri List<string> Allowed redirect URIs after the authentication [optional]
Audience string Audience claim to be used as part of the authentication flow. In case set, it must match the one configured on the Identity Provider's Application [optional]
AuditLogsClaims List<string> Subclaims to include in audit logs, e.g &quot;- -audit-logs-claims email - -audit-logs-claims username&quot; [optional]
BoundIps List<string> A CIDR whitelist with the IPs that the access is restricted to [optional]
ClientId string Client ID [optional]
ClientSecret string Client Secret [optional]
DeleteProtection string Protection from accidental deletion of this object [true/false] [optional]
Description string Auth Method description [optional]
ForceSubClaims bool 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]
Issuer string Issuer URL [optional]
Json bool Set output format to JSON [optional] [default to false]
JwtTtl long Jwt TTL [optional] [default to 0]
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]
RequiredScopes List<string> RequiredScopes is a list of required scopes that the oidc method will request from the oidc provider and the user must approve [optional]
RequiredScopesPrefix string RequiredScopesPrefix is a a prefix to add to all required-scopes when requesting them from the oidc server (for example, azures' Application ID URI) [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 OIDC, 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.

[Back to Model list] [Back to API list] [Back to README]