Skip to content

Latest commit

 

History

History
70 lines (64 loc) · 4.63 KB

CreateAuthMethodCert.md

File metadata and controls

70 lines (64 loc) · 4.63 KB

Akeyless::CreateAuthMethodCert

Properties

Name Type Description Notes
access_expires Integer Access expiration date in Unix timestamp (select 0 for access without expiry date) [optional][default to 0]
allowed_client_type Array<String> limit the auth method usage for specific client types [cli,ui,gateway-admin,sdk,mobile,extension] [optional]
allowed_cors String Comma separated list of allowed CORS domains to be validated as part of the authentication flow. [optional]
audit_logs_claims Array<String> Subclaims to include in audit logs, e.g &quot;--audit-logs-claims email --audit-logs-claims username&quot; [optional]
bound_common_names Array<String> A list of names. At least one must exist in the Common Name. Supports globbing. [optional]
bound_dns_sans Array<String> A list of DNS names. At least one must exist in the SANs. Supports globbing. [optional]
bound_email_sans Array<String> A list of Email Addresses. At least one must exist in the SANs. Supports globbing. [optional]
bound_extensions Array<String> A list of extensions formatted as &quot;oid:value&quot;. Expects the extension value to be some type of ASN1 encoded string. All values much match. Supports globbing on &quot;value&quot;. [optional]
bound_ips Array<String> A CIDR whitelist with the IPs that the access is restricted to [optional]
bound_organizational_units Array<String> A list of Organizational Units names. At least one must exist in the OU field. [optional]
bound_uri_sans Array<String> A list of URIs. At least one must exist in the SANs. Supports globbing. [optional]
certificate_data String The certificate data in base64, if no file was provided [optional]
delete_protection String Protection from accidental deletion of this object [true/false] [optional]
description String Auth Method description [optional]
expiration_event_in Array<String> How many days before the expiration of the auth method would you like to be notified. [optional]
force_sub_claims Boolean if true: enforce role-association must include sub claims [optional]
gw_bound_ips Array<String> A CIDR whitelist with the GW IPs that the access is restricted to [optional]
json Boolean Set output format to JSON [optional][default to false]
jwt_ttl Integer Jwt TTL [optional][default to 0]
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]
product_type Array<String> Choose the relevant product type for the auth method [sm, sra, pm, dp, ca, ara] [optional]
require_crl_dp Boolean Require certificate CRL distribution points (CDP) and enforce CRL validation during authentication. [optional]
revoked_cert_ids Array<String> A list of revoked cert ids [optional]
token String Authentication token (see `/auth` and `/configure`) [optional]
uid_token String The universal identity token, Required only for universal_identity authentication [optional]
unique_identifier String A unique identifier (ID) value should be configured, such as common_name or organizational_unit 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.

Example

require 'akeyless'

instance = Akeyless::CreateAuthMethodCert.new(
  access_expires: null,
  allowed_client_type: null,
  allowed_cors: null,
  audit_logs_claims: null,
  bound_common_names: null,
  bound_dns_sans: null,
  bound_email_sans: null,
  bound_extensions: null,
  bound_ips: null,
  bound_organizational_units: null,
  bound_uri_sans: null,
  certificate_data: null,
  delete_protection: null,
  description: null,
  expiration_event_in: null,
  force_sub_claims: null,
  gw_bound_ips: null,
  json: null,
  jwt_ttl: null,
  name: null,
  owner: null,
  product_type: null,
  require_crl_dp: null,
  revoked_cert_ids: null,
  token: null,
  uid_token: null,
  unique_identifier: null
)