@itentialopensource/adapter-hashicorp_vault
Version:
This adapter integrates with system described as: hashicorp_vault.
1,851 lines (1,850 loc) • 404 kB
YAML
openapi: 3.0.0
info:
title: HashiCorp Vault API
description: HTTP API that gives you full access to Vault. All API routes are prefixed with `/v1/`.
contact: {}
version: '1.5.3'
servers:
- url: https://{defaultHost}
variables:
defaultHost:
default: www.example.com
paths:
/Skywalker-kv/config:
get:
tags:
- secrets
summary: getSkywalkerKvConfig
description: Configures settings for the KV store
operationId: getSkywalkerKvConfig
parameters: []
responses:
'200':
description: OK
headers: {}
content: {}
deprecated: false
post:
tags:
- secrets
summary: postSkywalkerKvConfig
description: Configures settings for the KV store
operationId: postSkywalkerKvConfig
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/SkywalkerKvConfigRequest'
required: false
responses:
'200':
description: OK
headers: {}
content: {}
deprecated: false
/Skywalker-kv/data/{path}:
get:
tags:
- secrets
summary: getSkywalkerKvDataPath
description: Write, Read, and Delete data in the Key-Value Store.
operationId: getSkywalkerKvDataPath
parameters:
- name: path
in: path
description: Location of the secret.
required: true
style: simple
schema:
type: string
responses:
'200':
description: OK
headers: {}
content: {}
deprecated: false
post:
tags:
- secrets
summary: postSkywalkerKvDataPath
description: Write, Read, and Delete data in the Key-Value Store.
operationId: postSkywalkerKvDataPath
parameters:
- name: path
in: path
description: Location of the secret.
required: true
style: simple
schema:
type: string
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/SkywalkerKvDataRequest'
required: false
responses:
'200':
description: OK
headers: {}
content: {}
deprecated: false
delete:
tags:
- secrets
summary: deleteSkywalkerKvDataPath
description: Write, Read, and Delete data in the Key-Value Store.
operationId: deleteSkywalkerKvDataPath
parameters:
- name: path
in: path
description: Location of the secret.
required: true
style: simple
schema:
type: string
responses:
'204':
description: empty body
headers: {}
content: {}
deprecated: false
/Skywalker-kv/delete/{path}:
post:
tags:
- secrets
summary: postSkywalkerKvDeletePath
description: Marks one or more versions as deleted in the KV store.
operationId: postSkywalkerKvDeletePath
parameters:
- name: path
in: path
description: Location of the secret.
required: true
style: simple
schema:
type: string
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/SkywalkerKvDeleteRequest'
required: false
responses:
'200':
description: OK
headers: {}
content: {}
deprecated: false
/Skywalker-kv/destroy/{path}:
post:
tags:
- secrets
summary: postSkywalkerKvDestroyPath
description: Permanently removes one or more versions in the KV store
operationId: postSkywalkerKvDestroyPath
parameters:
- name: path
in: path
description: Location of the secret.
required: true
style: simple
schema:
type: string
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/SkywalkerKvDestroyRequest'
required: false
responses:
'200':
description: OK
headers: {}
content: {}
deprecated: false
/Skywalker-kv/metadata/{path}:
get:
tags:
- secrets
summary: getSkywalkerKvMetadataPath
description: Configures settings for the KV store
operationId: getSkywalkerKvMetadataPath
parameters:
- name: path
in: path
description: Location of the secret.
required: true
style: simple
schema:
type: string
- name: list
in: query
description: Return a list if `true`
style: form
explode: true
schema:
type: string
responses:
'200':
description: OK
headers: {}
content: {}
deprecated: false
post:
tags:
- secrets
summary: postSkywalkerKvMetadataPath
description: Configures settings for the KV store
operationId: postSkywalkerKvMetadataPath
parameters:
- name: path
in: path
description: Location of the secret.
required: true
style: simple
schema:
type: string
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/SkywalkerKvMetadataRequest'
required: false
responses:
'200':
description: OK
headers: {}
content: {}
deprecated: false
delete:
tags:
- secrets
summary: deleteSkywalkerKvMetadataPath
description: Configures settings for the KV store
operationId: deleteSkywalkerKvMetadataPath
parameters:
- name: path
in: path
description: Location of the secret.
required: true
style: simple
schema:
type: string
responses:
'204':
description: empty body
headers: {}
content: {}
deprecated: false
/Skywalker-kv/undelete/{path}:
post:
tags:
- secrets
summary: postSkywalkerKvUndeletePath
description: Undeletes one or more versions from the KV store.
operationId: postSkywalkerKvUndeletePath
parameters:
- name: path
in: path
description: Location of the secret.
required: true
style: simple
schema:
type: string
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/SkywalkerKvUndeleteRequest'
required: false
responses:
'200':
description: OK
headers: {}
content: {}
deprecated: false
/cubbyhole/{path}:
get:
tags:
- secrets
summary: getCubbyholePath
description: Pass-through secret storage to a token-specific cubbyhole in the storage backend, allowing you to read/write arbitrary data into secret storage.
operationId: getCubbyholePath
parameters:
- name: path
in: path
description: Specifies the path of the secret.
required: true
style: simple
schema:
type: string
- name: list
in: query
description: Return a list if `true`
style: form
explode: true
schema:
type: string
responses:
'200':
description: OK
headers: {}
content: {}
deprecated: false
post:
tags:
- secrets
summary: postCubbyholePath
description: Pass-through secret storage to a token-specific cubbyhole in the storage backend, allowing you to read/write arbitrary data into secret storage.
operationId: postCubbyholePath
parameters:
- name: path
in: path
description: Specifies the path of the secret.
required: true
style: simple
schema:
type: string
responses:
'200':
description: OK
headers: {}
content: {}
deprecated: false
delete:
tags:
- secrets
summary: deleteCubbyholePath
description: Pass-through secret storage to a token-specific cubbyhole in the storage backend, allowing you to read/write arbitrary data into secret storage.
operationId: deleteCubbyholePath
parameters:
- name: path
in: path
description: Specifies the path of the secret.
required: true
style: simple
schema:
type: string
responses:
'204':
description: empty body
headers: {}
content: {}
deprecated: false
/jedi-users/config:
get:
tags:
- secrets
summary: getJediUsersConfig
description: Configures settings for the KV store
operationId: getJediUsersConfig
parameters: []
responses:
'200':
description: OK
headers: {}
content: {}
deprecated: false
post:
tags:
- secrets
summary: postJediUsersConfig
description: Configures settings for the KV store
operationId: postJediUsersConfig
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/JediUsersConfigRequest'
required: false
responses:
'200':
description: OK
headers: {}
content: {}
deprecated: false
/jedi-users/data/{path}:
get:
tags:
- secrets
summary: getJediUsersDataPath
description: Write, Read, and Delete data in the Key-Value Store.
operationId: getJediUsersDataPath
parameters:
- name: path
in: path
description: Location of the secret.
required: true
style: simple
schema:
type: string
responses:
'200':
description: OK
headers: {}
content: {}
deprecated: false
post:
tags:
- secrets
summary: postJediUsersDataPath
description: Write, Read, and Delete data in the Key-Value Store.
operationId: postJediUsersDataPath
parameters:
- name: path
in: path
description: Location of the secret.
required: true
style: simple
schema:
type: string
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/JediUsersDataRequest'
required: false
responses:
'200':
description: OK
headers: {}
content: {}
deprecated: false
delete:
tags:
- secrets
summary: deleteJediUsersDataPath
description: Write, Read, and Delete data in the Key-Value Store.
operationId: deleteJediUsersDataPath
parameters:
- name: path
in: path
description: Location of the secret.
required: true
style: simple
schema:
type: string
responses:
'204':
description: empty body
headers: {}
content: {}
deprecated: false
/jedi-users/delete/{path}:
post:
tags:
- secrets
summary: postJediUsersDeletePath
description: Marks one or more versions as deleted in the KV store.
operationId: postJediUsersDeletePath
parameters:
- name: path
in: path
description: Location of the secret.
required: true
style: simple
schema:
type: string
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/JediUsersDeleteRequest'
required: false
responses:
'200':
description: OK
headers: {}
content: {}
deprecated: false
/jedi-users/destroy/{path}:
post:
tags:
- secrets
summary: postJediUsersDestroyPath
description: Permanently removes one or more versions in the KV store
operationId: postJediUsersDestroyPath
parameters:
- name: path
in: path
description: Location of the secret.
required: true
style: simple
schema:
type: string
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/JediUsersDestroyRequest'
required: false
responses:
'200':
description: OK
headers: {}
content: {}
deprecated: false
/jedi-users/metadata/{path}:
get:
tags:
- secrets
summary: getJediUsersMetadataPath
description: Configures settings for the KV store
operationId: getJediUsersMetadataPath
parameters:
- name: path
in: path
description: Location of the secret.
required: true
style: simple
schema:
type: string
- name: list
in: query
description: Return a list if `true`
style: form
explode: true
schema:
type: string
responses:
'200':
description: OK
headers: {}
content: {}
deprecated: false
post:
tags:
- secrets
summary: postJediUsersMetadataPath
description: Configures settings for the KV store
operationId: postJediUsersMetadataPath
parameters:
- name: path
in: path
description: Location of the secret.
required: true
style: simple
schema:
type: string
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/JediUsersMetadataRequest'
required: false
responses:
'200':
description: OK
headers: {}
content: {}
deprecated: false
delete:
tags:
- secrets
summary: deleteJediUsersMetadataPath
description: Configures settings for the KV store
operationId: deleteJediUsersMetadataPath
parameters:
- name: path
in: path
description: Location of the secret.
required: true
style: simple
schema:
type: string
responses:
'204':
description: empty body
headers: {}
content: {}
deprecated: false
/jedi-users/undelete/{path}:
post:
tags:
- secrets
summary: postJediUsersUndeletePath
description: Undeletes one or more versions from the KV store.
operationId: postJediUsersUndeletePath
parameters:
- name: path
in: path
description: Location of the secret.
required: true
style: simple
schema:
type: string
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/JediUsersUndeleteRequest'
required: false
responses:
'200':
description: OK
headers: {}
content: {}
deprecated: false
/kv/config:
get:
tags:
- secrets
summary: getKvConfig
description: Configures settings for the KV store
operationId: getKvConfig
parameters: []
responses:
'200':
description: OK
headers: {}
content: {}
deprecated: false
post:
tags:
- secrets
summary: postKvConfig
description: Configures settings for the KV store
operationId: postKvConfig
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/KvConfigRequest'
required: false
responses:
'200':
description: OK
headers: {}
content: {}
deprecated: false
/kv/data/{path}:
get:
tags:
- secrets
summary: getKvDataPath
description: Write, Read, and Delete data in the Key-Value Store.
operationId: getKvDataPath
parameters:
- name: path
in: path
description: Location of the secret.
required: true
style: simple
schema:
type: string
responses:
'200':
description: OK
headers: {}
content: {}
deprecated: false
post:
tags:
- secrets
summary: postKvDataPath
description: Write, Read, and Delete data in the Key-Value Store.
operationId: postKvDataPath
parameters:
- name: path
in: path
description: Location of the secret.
required: true
style: simple
schema:
type: string
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/KvDataRequest'
required: false
responses:
'200':
description: OK
headers: {}
content: {}
deprecated: false
delete:
tags:
- secrets
summary: deleteKvDataPath
description: Write, Read, and Delete data in the Key-Value Store.
operationId: deleteKvDataPath
parameters:
- name: path
in: path
description: Location of the secret.
required: true
style: simple
schema:
type: string
responses:
'204':
description: empty body
headers: {}
content: {}
deprecated: false
/kv/delete/{path}:
post:
tags:
- secrets
summary: postKvDeletePath
description: Marks one or more versions as deleted in the KV store.
operationId: postKvDeletePath
parameters:
- name: path
in: path
description: Location of the secret.
required: true
style: simple
schema:
type: string
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/KvDeleteRequest'
required: false
responses:
'200':
description: OK
headers: {}
content: {}
deprecated: false
/kv/destroy/{path}:
post:
tags:
- secrets
summary: postKvDestroyPath
description: Permanently removes one or more versions in the KV store
operationId: postKvDestroyPath
parameters:
- name: path
in: path
description: Location of the secret.
required: true
style: simple
schema:
type: string
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/KvDestroyRequest'
required: false
responses:
'200':
description: OK
headers: {}
content: {}
deprecated: false
/kv/metadata/{path}:
get:
tags:
- secrets
summary: getKvMetadataPath
description: Configures settings for the KV store
operationId: getKvMetadataPath
parameters:
- name: path
in: path
description: Location of the secret.
required: true
style: simple
schema:
type: string
- name: list
in: query
description: Return a list if `true`
style: form
explode: true
schema:
type: string
responses:
'200':
description: OK
headers: {}
content: {}
deprecated: false
post:
tags:
- secrets
summary: postKvMetadataPath
description: Configures settings for the KV store
operationId: postKvMetadataPath
parameters:
- name: path
in: path
description: Location of the secret.
required: true
style: simple
schema:
type: string
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/KvMetadataRequest'
required: false
responses:
'200':
description: OK
headers: {}
content: {}
deprecated: false
delete:
tags:
- secrets
summary: deleteKvMetadataPath
description: Configures settings for the KV store
operationId: deleteKvMetadataPath
parameters:
- name: path
in: path
description: Location of the secret.
required: true
style: simple
schema:
type: string
responses:
'204':
description: empty body
headers: {}
content: {}
deprecated: false
/kv/undelete/{path}:
post:
tags:
- secrets
summary: postKvUndeletePath
description: Undeletes one or more versions from the KV store.
operationId: postKvUndeletePath
parameters:
- name: path
in: path
description: Location of the secret.
required: true
style: simple
schema:
type: string
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/KvUndeleteRequest'
required: false
responses:
'200':
description: OK
headers: {}
content: {}
deprecated: false
/pki/ca:
get:
tags:
- secrets
summary: getPkiCa
description: Fetch a CA, CRL, CA Chain, or non-revoked certificate.
operationId: getPkiCa
parameters: []
responses:
'200':
description: OK
headers: {}
content: {}
deprecated: false
/pki/ca/pem:
get:
tags:
- secrets
summary: getPkiCaPem
description: Fetch a CA, CRL, CA Chain, or non-revoked certificate.
operationId: getPkiCaPem
parameters: []
responses:
'200':
description: OK
headers: {}
content: {}
deprecated: false
/pki/ca_chain:
get:
tags:
- secrets
summary: getPkiCa_chain
description: Fetch a CA, CRL, CA Chain, or non-revoked certificate.
operationId: getPkiCa_chain
parameters: []
responses:
'200':
description: OK
headers: {}
content: {}
deprecated: false
/pki/cert/ca_chain:
get:
tags:
- secrets
summary: getPkiCertCa_chain
description: Fetch a CA, CRL, CA Chain, or non-revoked certificate.
operationId: getPkiCertCa_chain
parameters: []
responses:
'200':
description: OK
headers: {}
content: {}
deprecated: false
/pki/cert/crl:
get:
tags:
- secrets
summary: getPkiCertCrl
description: Fetch a CA, CRL, CA Chain, or non-revoked certificate.
operationId: getPkiCertCrl
parameters: []
responses:
'200':
description: OK
headers: {}
content: {}
deprecated: false
/pki/cert/{serial}:
get:
tags:
- secrets
summary: getPkiCertSerial
description: Fetch a CA, CRL, CA Chain, or non-revoked certificate.
operationId: getPkiCertSerial
parameters:
- name: serial
in: path
description: Certificate serial number, in colon- or hyphen-separated octal
required: true
style: simple
schema:
type: string
responses:
'200':
description: OK
headers: {}
content: {}
deprecated: false
/pki/certs:
get:
tags:
- secrets
summary: getPkiCerts
description: Fetch a CA, CRL, CA Chain, or non-revoked certificate.
operationId: getPkiCerts
parameters:
- name: list
in: query
description: Return a list if `true`
style: form
explode: true
schema:
type: string
responses:
'200':
description: OK
headers: {}
content: {}
deprecated: false
/pki/config/ca:
post:
tags:
- secrets
summary: postPkiConfigCa
description: Set the CA certificate and private key used for generated credentials.
operationId: postPkiConfigCa
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PkiConfigCaRequest'
required: false
responses:
'200':
description: OK
headers: {}
content: {}
deprecated: false
/pki/config/crl:
get:
tags:
- secrets
summary: getPkiConfigCrl
description: Configure the CRL expiration.
operationId: getPkiConfigCrl
parameters: []
responses:
'200':
description: OK
headers: {}
content: {}
deprecated: false
post:
tags:
- secrets
summary: postPkiConfigCrl
description: Configure the CRL expiration.
operationId: postPkiConfigCrl
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PkiConfigCrlRequest'
required: false
responses:
'200':
description: OK
headers: {}
content: {}
deprecated: false
/pki/config/urls:
get:
tags:
- secrets
summary: getPkiConfigUrls
description: Set the URLs for the issuing CA, CRL distribution points, and OCSP servers.
operationId: getPkiConfigUrls
parameters: []
responses:
'200':
description: OK
headers: {}
content: {}
deprecated: false
post:
tags:
- secrets
summary: postPkiConfigUrls
description: Set the URLs for the issuing CA, CRL distribution points, and OCSP servers.
operationId: postPkiConfigUrls
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PkiConfigUrlsRequest'
required: false
responses:
'200':
description: OK
headers: {}
content: {}
deprecated: false
/pki/crl:
get:
tags:
- secrets
summary: getPkiCrl
description: Fetch a CA, CRL, CA Chain, or non-revoked certificate.
operationId: getPkiCrl
parameters: []
responses:
'200':
description: OK
headers: {}
content: {}
deprecated: false
/pki/crl/pem:
get:
tags:
- secrets
summary: getPkiCrlPem
description: Fetch a CA, CRL, CA Chain, or non-revoked certificate.
operationId: getPkiCrlPem
parameters: []
responses:
'200':
description: OK
headers: {}
content: {}
deprecated: false
/pki/crl/rotate:
get:
tags:
- secrets
summary: getPkiCrlRotate
description: Force a rebuild of the CRL.
operationId: getPkiCrlRotate
parameters: []
responses:
'200':
description: OK
headers: {}
content: {}
deprecated: false
/pki/intermediate/generate/{exported}:
post:
tags:
- secrets
summary: postPkiIntermediateGenerateExported
description: Generate a new CSR and private key used for signing.
operationId: postPkiIntermediateGenerateExported
parameters:
- name: exported
in: path
description: Must be "internal" or "exported". If set to "exported", the generated private key will be returned. This is your *only* chance to retrieve the private key!
required: true
style: simple
schema:
type: string
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PkiIntermediateGenerateRequest'
required: false
responses:
'200':
description: OK
headers: {}
content: {}
deprecated: false
/pki/intermediate/set-signed:
post:
tags:
- secrets
summary: postPkiIntermediateSetSigned
description: Provide the signed intermediate CA cert.
operationId: postPkiIntermediateSetSigned
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PkiIntermediateSetSignedRequest'
required: false
responses:
'200':
description: OK
headers: {}
content: {}
deprecated: false
/pki/issue/{role}:
post:
tags:
- secrets
summary: postPkiIssueRole
description: Request a certificate using a certain role with the provided details.
operationId: postPkiIssueRole
parameters:
- name: role
in: path
description: The desired role with configuration for this request
required: true
style: simple
schema:
type: string
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PkiIssueRequest'
required: false
responses:
'200':
description: OK
headers: {}
content: {}
deprecated: false
/pki/revoke:
post:
tags:
- secrets
summary: postPkiRevoke
description: Revoke a certificate by serial number.
operationId: postPkiRevoke
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PkiRevokeRequest'
required: false
responses:
'200':
description: OK
headers: {}
content: {}
deprecated: false
/pki/roles:
get:
tags:
- secrets
summary: getPkiRoles
description: List the existing roles in this backend
operationId: getPkiRoles
parameters:
- name: list
in: query
description: Return a list if `true`
style: form
explode: true
schema:
type: string
responses:
'200':
description: OK
headers: {}
content: {}
deprecated: false
/pki/roles/{name}:
get:
tags:
- secrets
summary: getPkiRolesName
description: Manage the roles that can be created with this backend.
operationId: getPkiRolesName
parameters:
- name: name
in: path
description: Name of the role
required: true
style: simple
schema:
type: string
responses:
'200':
description: OK
headers: {}
content: {}
deprecated: false
post:
tags:
- secrets
summary: postPkiRolesName
description: Manage the roles that can be created with this backend.
operationId: postPkiRolesName
parameters:
- name: name
in: path
description: Name of the role
required: true
style: simple
schema:
type: string
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PkiRolesRequest'
required: false
responses:
'200':
description: OK
headers: {}
content: {}
deprecated: false
delete:
tags:
- secrets
summary: deletePkiRolesName
description: Manage the roles that can be created with this backend.
operationId: deletePkiRolesName
parameters:
- name: name
in: path
description: Name of the role
required: true
style: simple
schema:
type: string
responses:
'204':
description: empty body
headers: {}
content: {}
deprecated: false
/pki/root:
delete:
tags:
- secrets
summary: deletePkiRoot
description: Deletes the root CA key to allow a new one to be generated.
operationId: deletePkiRoot
parameters: []
responses:
'204':
description: empty body
headers: {}
content: {}
deprecated: false
/pki/root/generate/{exported}:
post:
tags:
- secrets
summary: postPkiRootGenerateExported
description: Generate a new CA certificate and private key used for signing.
operationId: postPkiRootGenerateExported
parameters:
- name: exported
in: path
description: Must be "internal" or "exported". If set to "exported", the generated private key will be returned. This is your *only* chance to retrieve the private key!
required: true
style: simple
schema:
type: string
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PkiRootGenerateRequest'
required: false
responses:
'200':
description: OK
headers: {}
content: {}
deprecated: false
/pki/root/sign-intermediate:
post:
tags:
- secrets
summary: postPkiRootSignIntermediate
description: Issue an intermediate CA certificate based on the provided CSR.
operationId: postPkiRootSignIntermediate
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PkiRootSignIntermediateRequest'
required: false
responses:
'200':
description: OK
headers: {}
content: {}
deprecated: false
/pki/root/sign-self-issued:
post:
tags:
- secrets
summary: postPkiRootSignSelfIssued
description: Signs another CA's self-issued certificate.
operationId: postPkiRootSignSelfIssued
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PkiRootSignSelfIssuedRequest'
required: false
responses:
'200':
description: OK
headers: {}
content: {}
deprecated: false
/pki/sign-verbatim:
post:
tags:
- secrets
summary: postPkiSignVerbatim
description: Request certificates using a certain role with the provided details.
operationId: postPkiSignVerbatim
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PkiSignVerbatimRequest'
required: false
responses:
'200':
description: OK
headers: {}
content: {}
deprecated: false
/pki/sign-verbatim/{role}:
post:
tags:
- secrets
summary: postPkiSignVerbatimRole
description: Request certificates using a certain role with the provided details.
operationId: postPkiSignVerbatimRole
parameters:
- name: role
in: path
description: The desired role with configuration for this request
required: true
style: simple
schema:
type: string
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PkiSignVerbatimRequest1'
required: false
responses:
'200':
description: OK
headers: {}
content: {}
deprecated: false
/pki/sign/{role}:
post:
tags:
- secrets
summary: postPkiSignRole
description: Request certificates using a certain role with the provided details.
operationId: postPkiSignRole
parameters:
- name: role
in: path
description: The desired role with configuration for this request
required: true
style: simple
schema:
type: string
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PkiSignRequest'
required: false
responses:
'200':
description: OK
headers: {}
content: {}
deprecated: false
/pki/tidy:
post:
tags:
- secrets
summary: postPkiTidy
description: Tidy up the backend by removing expired certificates, revocation information, or both.
operationId: postPkiTidy
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PkiTidyRequest'
required: false
responses:
'200':
description: OK
headers: {}
content: {}
deprecated: false
/auth/approle/login:
post:
tags:
- auth
summary: postAuthApproleLogin
description: Issue a token based on the credentials supplied
operationId: postAuthApproleLogin
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/AuthApproleLoginRequest'
required: false
responses:
'200':
description: OK
headers: {}
content: {}
deprecated: false
/auth/approle/role:
get:
tags:
- auth
summary: getAuthApproleRole
description: Lists all the roles registered with the backend.
operationId: getAuthApproleRole
parameters:
- name: list
in: query
description: Return a list if `true`
style: form
explode: true
schema:
type: string
responses:
'200':
description: OK
headers: {}
content: {}
deprecated: false
/auth/approle/role/{role_name}:
get:
tags:
- auth
summary: getAuthApproleRoleRole_name
description: Register an role with the backend.
operationId: getAuthApproleRoleRole_name
parameters:
- name: role_name
in: path
description: Name of the role.
required: true
style: simple
schema:
type: string
responses:
'200':
description: OK
headers: {}
content: {}
deprecated: false
post:
tags:
- auth
summary: postAuthApproleRoleRole_name
description: Register an role with the backend.
operationId: postAuthApproleRoleRole_name
parameters:
- name: role_name
in: path
description: Name of the role.
required: true
style: simple
schema:
type: string
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/AuthApproleRoleRequest'
required: false
responses:
'200':
description: OK
headers: {}
content: {}
deprecated: false
delete:
tags:
- auth
summary: deleteAuthApproleRoleRole_name
description: Register an role with the backend.
operationId: deleteAuthApproleRoleRole_name
parameters:
- name: role_name
in: path
description: Name of the role.
required: true
style: simple
schema:
type: string
responses:
'204':
description: empty body
headers: {}
content: {}
deprecated: false
/auth/approle/role/{role_name}/bind-secret-id:
get:
tags:
- auth
summary: getAuthApproleRoleRole_nameBindSecretId
description: Impose secret_id to be presented during login using this role.
operationId: getAuthApproleRoleRole_nameBindSecretId
parameters:
- name: role_name
in: path
description: Name of the role.
required: true
style: simple
schema:
type: string
responses:
'200':
description: OK
headers: {}
content: {}
deprecated: false
post:
tags:
- auth
summary: postAuthApproleRoleRole_nameBindSecretId
description: Impose secret_id to be presented during login using this role.
operationId: postAuthApproleRoleRole_nameBindSecretId
parameters:
- name: role_name
in: path
description: Name of the role.
required: true
style: simple
schema:
type: string
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/AuthApproleRoleBindSecretIdRequest'
required: false
responses:
'200':
description: OK
headers: {}
content: {}
deprecated: false
delete:
tags:
- auth
summary: deleteAuthApproleRoleRole_nameBindSecretId
description: Impose secret_id to be presented during login using this role.
operationId: deleteAuthApproleRoleRole_nameBindSecretId
parameters:
- name: role_name
in: path
description: Name of the role.
required: true
style: simple
schema:
type: string
responses:
'204':
description: empty body
headers: {}
content: {}
deprecated: false
/auth/approle/role/{role_name}/bound-cidr-list:
get:
tags:
- auth
summary: getAuthApproleRoleRole_nameBoundCidrList
description: 'Deprecated: Comma separated list of CIDR blocks, if set, specifies blocks of IP addresses which can perform the login operation'
operationId: getAuthApproleRoleRole_nameBoundCidrList
parameters:
- name: role_name
in: path
description: Name of the role.
required: true
style: simple
schema:
type: string
responses:
'200':
description: OK
headers: {}
content: {}
deprecated: false
post:
tags:
- auth
summary: postAuthApproleRoleRole_nameBoundCidrList
description: 'Deprecated: Comma separated list of CIDR blocks, if set, specifies blocks of IP addresses which can perform the login operation'
operationId: postAuthApproleRoleRole_nameBoundCidrList
parameters:
- name: role_name
in: path
description: Name of the role.
required: true
style: simple
schema:
type: string
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/AuthApproleRoleBoundCidrListRequest'
required: false
responses:
'200':
description: OK
headers: {}
content: {}
deprecated: false
delete:
tags:
- auth
summary: deleteAuthApproleRoleRole_nameBoundCidrList
description: 'Deprecated: Comma separated list of CIDR blocks, if set, specifies blocks of IP addresses which can perform the login operation'
operationId: deleteAuthApproleRoleRole_nameBoundCidrList
parameters:
- name: role_name
in: path
description: Name of the role.
required: true
style: simple
schema:
type: string
responses:
'204':
description: empty body
headers: {}
content: {}
deprecated: false
/auth/approle/role/{role_name}/custom-secret-id:
post:
tags:
- auth
summary: postAuthApproleRoleRole_nameCustomSecretId
description: Assign a SecretID of choice against the role.
operationId: postAuthApproleRoleRole_nameCustomSecretId
parameters:
- name: role_name
in: path
description: Name of the role.
required: true
style: simple
schema:
type: string
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/AuthApproleRoleCustomSecretIdRequest'
required: false
responses:
'200':
description: OK
headers: {}
content: {}
deprecated: false
/auth/approle/role/{role_name}/local-secret-ids:
get:
tags:
- auth
summary: getAuthApproleRoleRole_nameLocalSecretIds
description: Enables cluster local secret IDs
operationId: getAuthApproleRoleRole_nameLocalSecretIds
parameters:
- name: role_name
in: path
description: Name of the role.
required: true
style: simple
schema:
type: string
responses:
'200':
description: OK
headers: {}
content: {}
deprecated: false
/auth/approle/role/{role_name}/period:
get:
tags:
- auth
summary: getAuthApproleRoleRole_namePeriod
description: Updates the value of 'period' on the role
operationId: getAuthApproleRoleRole_namePeriod
parameters:
- name: role_name
in: path
description: Name of the role.
required: true
style: simple
schema:
type: string
responses:
'200':
description: OK
headers: {}
content: {}
deprecated: false
post:
tags:
- auth
summary: postAuthApproleRoleRole_namePeriod
description: Updates the value of 'period' on the role
operationId: postAuthApproleRoleRole_namePeriod
parameters:
- name: role_name
in: path
description: Name of the role.
required: true
style: simple
schema:
type: string
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/AuthApproleRolePeriodRequest'
required: false
responses:
'200':
description: OK
headers: {}
content: {}
deprecated: false
delete:
tags:
- auth
summary: deleteAuthApproleRoleRole_namePeriod
description: Updates the value of 'period' on the role
operationId: deleteAuthApproleRoleRole_namePeriod
parameters:
- name: role_name
in: path
description: Name of the role.
required: true
style: simple
schema:
type: string
responses:
'204':
description: empty body
headers: {}
content: {}
deprecated: false
/auth/approle/role/{role_name}/policies:
get:
tags:
- auth
summary: getAuthApproleRoleRole_namePolicies
description: Policies of the role.
operationId: getAuthApproleRoleRole_namePolicies
parameters:
- name: role_name
in: path
description: Name of the role.
required: true