POST
/
vault-forward
/
configs
/
{config_id}
/
authentications

This endpoint requires the vault-forward-authentications.write scope.

Authorizations

Authorization
string
headerrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

config_id
string
required

The ID of the Vault Forward configuration.

Body

application/json
kind
enum<string>
required

The kind of authentication to be used in a Vault Forward request.

Available options:
mle,
mtls,
signature
display_name
string
required

A custom name for the authentication method. This will be shown in the Admin UI.

fields
object[]
required

A list of fields, each containing a key-value pair for each field defined by the definition for this authentication method.

Response

201 - application/json
type
string
default: vault-forward-config-authentication

The type of this resource. It is always vault-forward-config-authentication.

id
string

The ID of this Vault Forward authentication method.

created_at
string

The date and time when this configuration was created.

updated_at
string

The date and time when this configuration was last updated.

kind
enum<string>

The kind of authentication to be used in a Vault Forward request.

Available options:
mle,
mtls,
signature
label
string

A label that describes this authentication method.

display_name
string

The display name for this authentication method given when created.

fields
object[]

A list of fields, each containing a key-value pair for each field configured for this authentication method. Fields marked as secret are not returned.

creator
object | null

The user who created the Vault Forward authentication method.

Was this page helpful?

Get authenticationUpdate authentication