Skip to content

Latest commit

 

History

History
40 lines (32 loc) · 3.97 KB

AuthMethodCreateCert.md

File metadata and controls

40 lines (32 loc) · 3.97 KB

AuthMethodCreateCert

authMethodCreateCert is a command that creates a new auth method that will be able to authenticate using a client certificate

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]
allowedCors String Comma separated list of allowed CORS domains to be validated as part of the authentication flow. [optional]
auditLogsClaims List<String> Subclaims to include in audit logs, e.g &quot;--audit-logs-claims email --audit-logs-claims username&quot; [optional]
boundCommonNames List<String> A list of names. At least one must exist in the Common Name. Supports globbing. [optional]
boundDnsSans List<String> A list of DNS names. At least one must exist in the SANs. Supports globbing. [optional]
boundEmailSans List<String> A list of Email Addresses. At least one must exist in the SANs. Supports globbing. [optional]
boundExtensions List<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]
boundIps List<String> A CIDR whitelist with the IPs that the access is restricted to [optional]
boundOrganizationalUnits List<String> A list of Organizational Units names. At least one must exist in the OU field. [optional]
boundUriSans List<String> A list of URIs. At least one must exist in the SANs. Supports globbing. [optional]
certificateData String The certificate data in base64, if no file was provided [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]
gwBoundIps List<String> A CIDR whitelist with the GW IPs that the access is restricted to [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]
requireCrlDp Boolean Require certificate CRL distribution points (CDP) and enforce CRL validation during authentication. [optional]
revokedCertIds List<String> A list of revoked cert ids [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, 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.