Skip to content

Latest commit

 

History

History
39 lines (31 loc) · 3.82 KB

CreateAuthMethodOIDC.md

File metadata and controls

39 lines (31 loc) · 3.82 KB

CreateAuthMethodOIDC

createAuthMethodOIDC is a command that creates a new auth method that will be available to authenticate using OIDC. [Deprecated: Use auth-method-create-oidc 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]
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]
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 working with Gateway mode [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]
jwtTtl Long Jwt TTL [optional]
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]
productType List<String> Choose the relevant product type for the auth method [sm, sra, pm, dp, ca, ara] [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.