AKakeyless
Authentication

POST /auth-method-create-api-key

Request

  • Base URL
    https://api.akeyless.io
  • URL
    https://api.akeyless.io/auth-method-create-api-key
  • Auth
    none declared

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]

audit-logs-claimsstring[]

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

bound-ipsstring[]

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

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, ara]

tokenstring

Authentication token (see /auth and /configure)

uid-tokenstring

The universal identity token, Required only for universal_identity authentication

Response

authMethodCreateApiKeyResponse wraps response body.

access_idstring
access_keystring
namestring
prv_keystring
scim_base_urlstring

SCIM Base URL the IdP calls, set when SCIM flags were given

Changes

No recorded changes to this operation across all 1 revision of this API.