v1

latestOpenAPI 3.0.02026-07-246171,3332.1 MB
v2

post/auth-method-create-cert

Request body

access-expiresinteger

Access expiration date in Unix timestamp (select 0 for access without expiry date)

allowed-client-typestring[]

limit the auth method usage for specific client types [cli,ui,gateway-admin,sdk,mobile,extension]

allowed-corsstring

Comma separated list of allowed CORS domains to be validated as part of the authentication flow.

audit-logs-claimsstring[]

Subclaims to include in audit logs, e.g "--audit-logs-claims email --audit-logs-claims username"

bound-common-namesstring[]

A list of names. At least one must exist in the Common Name. Supports globbing.

bound-dns-sansstring[]

A list of DNS names. At least one must exist in the SANs. Supports globbing.

bound-email-sansstring[]

A list of Email Addresses. At least one must exist in the SANs. Supports globbing.

bound-extensionsstring[]

A list of extensions formatted as "oid:value". Expects the extension value to be some type of ASN1 encoded string. All values much match. Supports globbing on "value".

bound-ipsstring[]

A CIDR whitelist with the IPs that the access is restricted to

bound-organizational-unitsstring[]

A list of Organizational Units names. At least one must exist in the OU field.

bound-uri-sansstring[]

A list of URIs. At least one must exist in the SANs. Supports globbing.

certificate-datastring

The certificate data in base64, if no file was provided

delete_protectionstring

Protection from accidental deletion of this object [true/false]

descriptionstring

Auth Method description

expiration-event-instring[]

How many days before the expiration of the auth method would you like to be notified.

force-sub-claimsboolean

if true: enforce role-association must include sub claims

gw-bound-ipsstring[]

A CIDR whitelist with the GW IPs that the access is restricted to

jsonboolean

Set output format to JSON

jwt-ttlinteger

Jwt TTL

namestring required

Auth Method name

product-typestring[]

Choose the relevant product type for the auth method [sm, sra, pm, dp, ca]

require-crl-dpboolean

Require certificate CRL distribution points (CDP) and enforce CRL validation during authentication.

revoked-cert-idsstring[]

A list of revoked cert ids

tokenstring

Authentication token (see /auth and /configure)

uid-tokenstring

The universal identity token, Required only for universal_identity authentication

unique-identifierstring required

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 "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.

Response

authMethodCreateCertResponse wraps response body.

access_idstring
access_keystring
namestring
prv_keystring