Skip to content

Latest commit

 

History

History
36 lines (32 loc) · 3.84 KB

CreateAuthMethodOIDC.md

File metadata and controls

36 lines (32 loc) · 3.84 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
access_expires int Access expiration date in Unix timestamp (select 0 for access without expiry date) [optional] [default to 0]
allowed_client_type list[str] limit the auth method usage for specific client types [cli,ui,gateway-admin,sdk,mobile,extension] [optional]
allowed_redirect_uri list[str] Allowed redirect URIs after the authentication [optional]
audience str 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]
audit_logs_claims list[str] Subclaims to include in audit logs, e.g "--audit-logs-claims email --audit-logs-claims username" [optional]
bound_ips list[str] A CIDR whitelist with the IPs that the access is restricted to [optional]
client_id str Client ID [optional]
client_secret str Client Secret [optional]
delete_protection str Protection from accidental deletion of this object [true/false] [optional]
description str Auth Method description [optional]
expiration_event_in list[str] How many days before the expiration of the auth method would you like to be notified. [optional]
force_sub_claims bool if true: enforce role-association must include sub claims [optional]
gateway_url str Akeyless Gateway URL (Configuration Management port). Relevant only when working with Gateway mode [optional]
gw_bound_ips list[str] A CIDR whitelist with the GW IPs that the access is restricted to [optional]
issuer str Issuer URL [optional]
json bool Set output format to JSON [optional] [default to False]
jwt_ttl int Jwt TTL [optional] [default to 0]
name str Auth Method name
owner str 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]
product_type list[str] Choose the relevant product type for the auth method [sm, sra, pm, dp, ca, ara] [optional]
required_scopes list[str] RequiredScopes is a list of required scopes that the oidc method will request from the oidc provider and the user must approve [optional]
required_scopes_prefix str 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]
subclaims_delimiters list[str] A list of additional sub claims delimiters (relevant only for SAML, OIDC, OAuth2/JWT) [optional]
token str Authentication token (see `/auth` and `/configure`) [optional]
uid_token str The universal identity token, Required only for universal_identity authentication [optional]
unique_identifier str 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 "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.

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