mirror of
https://github.com/Infisical/infisical.git
synced 2026-01-10 16:08:20 -05:00
1691 lines
38 KiB
YAML
1691 lines
38 KiB
YAML
openapi: 3.0.0
|
|
info:
|
|
title: Infisical API
|
|
description: List of all available APIs that can be consumed
|
|
version: 1.0.0
|
|
servers:
|
|
- url: http://localhost:8080
|
|
paths:
|
|
/api/v1/secret/{secretId}/secret-versions:
|
|
get:
|
|
description: ''
|
|
parameters:
|
|
- name: secretId
|
|
in: path
|
|
required: true
|
|
schema:
|
|
type: string
|
|
- name: offset
|
|
in: query
|
|
schema:
|
|
type: string
|
|
- name: limit
|
|
in: query
|
|
schema:
|
|
type: string
|
|
responses:
|
|
'200':
|
|
description: OK
|
|
'400':
|
|
description: Bad Request
|
|
/api/v1/secret/{secretId}/secret-versions/rollback:
|
|
post:
|
|
description: ''
|
|
parameters:
|
|
- name: secretId
|
|
in: path
|
|
required: true
|
|
schema:
|
|
type: string
|
|
responses:
|
|
'200':
|
|
description: OK
|
|
'400':
|
|
description: Bad Request
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
properties:
|
|
version:
|
|
example: any
|
|
/api/v1/secret-snapshot/{secretSnapshotId}:
|
|
get:
|
|
description: ''
|
|
parameters:
|
|
- name: secretSnapshotId
|
|
in: path
|
|
required: true
|
|
schema:
|
|
type: string
|
|
responses:
|
|
'200':
|
|
description: OK
|
|
'400':
|
|
description: Bad Request
|
|
/api/v1/workspace/{workspaceId}/secret-snapshots:
|
|
get:
|
|
description: ''
|
|
parameters:
|
|
- name: workspaceId
|
|
in: path
|
|
required: true
|
|
schema:
|
|
type: string
|
|
- name: offset
|
|
in: query
|
|
schema:
|
|
type: string
|
|
- name: limit
|
|
in: query
|
|
schema:
|
|
type: string
|
|
responses:
|
|
'200':
|
|
description: OK
|
|
'400':
|
|
description: Bad Request
|
|
/api/v1/workspace/{workspaceId}/secret-snapshots/count:
|
|
get:
|
|
description: ''
|
|
parameters:
|
|
- name: workspaceId
|
|
in: path
|
|
required: true
|
|
schema:
|
|
type: string
|
|
responses:
|
|
'200':
|
|
description: OK
|
|
'400':
|
|
description: Bad Request
|
|
/api/v1/workspace/{workspaceId}/secret-snapshots/rollback:
|
|
post:
|
|
description: ''
|
|
parameters:
|
|
- name: workspaceId
|
|
in: path
|
|
required: true
|
|
schema:
|
|
type: string
|
|
responses:
|
|
'200':
|
|
description: OK
|
|
'400':
|
|
description: Bad Request
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
properties:
|
|
version:
|
|
example: any
|
|
/api/v1/workspace/{workspaceId}/logs:
|
|
get:
|
|
description: ''
|
|
parameters:
|
|
- name: workspaceId
|
|
in: path
|
|
required: true
|
|
schema:
|
|
type: string
|
|
- name: offset
|
|
in: query
|
|
schema:
|
|
type: string
|
|
- name: limit
|
|
in: query
|
|
schema:
|
|
type: string
|
|
- name: sortBy
|
|
in: query
|
|
schema:
|
|
type: string
|
|
- name: userId
|
|
in: query
|
|
schema:
|
|
type: string
|
|
- name: actionNames
|
|
in: query
|
|
schema:
|
|
type: string
|
|
responses:
|
|
'200':
|
|
description: OK
|
|
'400':
|
|
description: Bad Request
|
|
/api/v1/action/{actionId}:
|
|
get:
|
|
description: ''
|
|
parameters:
|
|
- name: actionId
|
|
in: path
|
|
required: true
|
|
schema:
|
|
type: string
|
|
responses:
|
|
'200':
|
|
description: OK
|
|
/api/v1/signup/email/signup:
|
|
post:
|
|
description: ''
|
|
parameters: []
|
|
responses:
|
|
'200':
|
|
description: OK
|
|
'400':
|
|
description: Bad Request
|
|
'403':
|
|
description: Forbidden
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
properties:
|
|
email:
|
|
example: any
|
|
/api/v1/signup/email/verify:
|
|
post:
|
|
description: ''
|
|
parameters: []
|
|
responses:
|
|
'200':
|
|
description: OK
|
|
'400':
|
|
description: Bad Request
|
|
'403':
|
|
description: Forbidden
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
properties:
|
|
email:
|
|
example: any
|
|
code:
|
|
example: any
|
|
/api/v1/signup/complete-account/signup:
|
|
post:
|
|
description: ''
|
|
parameters: []
|
|
responses:
|
|
'200':
|
|
description: OK
|
|
'400':
|
|
description: Bad Request
|
|
'403':
|
|
description: Forbidden
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
properties:
|
|
email:
|
|
example: any
|
|
firstName:
|
|
example: any
|
|
lastName:
|
|
example: any
|
|
publicKey:
|
|
example: any
|
|
encryptedPrivateKey:
|
|
example: any
|
|
iv:
|
|
example: any
|
|
tag:
|
|
example: any
|
|
salt:
|
|
example: any
|
|
verifier:
|
|
example: any
|
|
organizationName:
|
|
example: any
|
|
/api/v1/signup/complete-account/invite:
|
|
post:
|
|
description: ''
|
|
parameters: []
|
|
responses:
|
|
'200':
|
|
description: OK
|
|
'400':
|
|
description: Bad Request
|
|
'403':
|
|
description: Forbidden
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
properties:
|
|
email:
|
|
example: any
|
|
firstName:
|
|
example: any
|
|
lastName:
|
|
example: any
|
|
publicKey:
|
|
example: any
|
|
encryptedPrivateKey:
|
|
example: any
|
|
iv:
|
|
example: any
|
|
tag:
|
|
example: any
|
|
salt:
|
|
example: any
|
|
verifier:
|
|
example: any
|
|
/api/v1/auth/token:
|
|
post:
|
|
description: ''
|
|
parameters: []
|
|
responses:
|
|
'200':
|
|
description: OK
|
|
'400':
|
|
description: Bad Request
|
|
/api/v1/auth/login1:
|
|
post:
|
|
description: ''
|
|
parameters: []
|
|
responses:
|
|
'200':
|
|
description: OK
|
|
'400':
|
|
description: Bad Request
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
properties:
|
|
email:
|
|
example: any
|
|
clientPublicKey:
|
|
example: any
|
|
/api/v1/auth/login2:
|
|
post:
|
|
description: ''
|
|
parameters: []
|
|
responses:
|
|
'200':
|
|
description: OK
|
|
'400':
|
|
description: Bad Request
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
properties:
|
|
email:
|
|
example: any
|
|
clientProof:
|
|
example: any
|
|
/api/v1/auth/logout:
|
|
post:
|
|
description: ''
|
|
parameters: []
|
|
responses:
|
|
'200':
|
|
description: OK
|
|
'400':
|
|
description: Bad Request
|
|
/api/v1/auth/checkAuth:
|
|
post:
|
|
description: ''
|
|
parameters: []
|
|
responses:
|
|
'200':
|
|
description: OK
|
|
/api/v1/bot/{workspaceId}:
|
|
get:
|
|
description: ''
|
|
parameters:
|
|
- name: workspaceId
|
|
in: path
|
|
required: true
|
|
schema:
|
|
type: string
|
|
responses:
|
|
'200':
|
|
description: OK
|
|
'400':
|
|
description: Bad Request
|
|
/api/v1/bot/{botId}/active:
|
|
patch:
|
|
description: ''
|
|
parameters:
|
|
- name: botId
|
|
in: path
|
|
required: true
|
|
schema:
|
|
type: string
|
|
responses:
|
|
'200':
|
|
description: OK
|
|
'400':
|
|
description: Bad Request
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
properties:
|
|
isActive:
|
|
example: any
|
|
botKey:
|
|
example: any
|
|
/api/v1/user/:
|
|
get:
|
|
description: ''
|
|
parameters: []
|
|
responses:
|
|
'200':
|
|
description: OK
|
|
/api/v1/user-action/:
|
|
post:
|
|
description: ''
|
|
parameters: []
|
|
responses:
|
|
'200':
|
|
description: OK
|
|
'400':
|
|
description: Bad Request
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
properties:
|
|
action:
|
|
example: any
|
|
get:
|
|
description: ''
|
|
parameters:
|
|
- name: action
|
|
in: query
|
|
schema:
|
|
type: string
|
|
responses:
|
|
'200':
|
|
description: OK
|
|
'400':
|
|
description: Bad Request
|
|
/api/v1/organization/:
|
|
get:
|
|
description: ''
|
|
parameters: []
|
|
responses:
|
|
'200':
|
|
description: OK
|
|
'400':
|
|
description: Bad Request
|
|
post:
|
|
description: ''
|
|
parameters: []
|
|
responses:
|
|
'200':
|
|
description: OK
|
|
'400':
|
|
description: Bad Request
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
properties:
|
|
organizationName:
|
|
example: any
|
|
/api/v1/organization/{organizationId}:
|
|
get:
|
|
description: ''
|
|
parameters:
|
|
- name: organizationId
|
|
in: path
|
|
required: true
|
|
schema:
|
|
type: string
|
|
responses:
|
|
'200':
|
|
description: OK
|
|
'400':
|
|
description: Bad Request
|
|
/api/v1/organization/{organizationId}/users:
|
|
get:
|
|
description: ''
|
|
parameters:
|
|
- name: organizationId
|
|
in: path
|
|
required: true
|
|
schema:
|
|
type: string
|
|
responses:
|
|
'200':
|
|
description: OK
|
|
'400':
|
|
description: Bad Request
|
|
/api/v1/organization/{organizationId}/my-workspaces:
|
|
get:
|
|
description: ''
|
|
parameters:
|
|
- name: organizationId
|
|
in: path
|
|
required: true
|
|
schema:
|
|
type: string
|
|
responses:
|
|
'200':
|
|
description: OK
|
|
'400':
|
|
description: Bad Request
|
|
/api/v1/organization/{organizationId}/name:
|
|
patch:
|
|
description: ''
|
|
parameters:
|
|
- name: organizationId
|
|
in: path
|
|
required: true
|
|
schema:
|
|
type: string
|
|
responses:
|
|
'200':
|
|
description: OK
|
|
'400':
|
|
description: Bad Request
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
properties:
|
|
name:
|
|
example: any
|
|
/api/v1/organization/{organizationId}/incidentContactOrg:
|
|
get:
|
|
description: ''
|
|
parameters:
|
|
- name: organizationId
|
|
in: path
|
|
required: true
|
|
schema:
|
|
type: string
|
|
responses:
|
|
'200':
|
|
description: OK
|
|
'400':
|
|
description: Bad Request
|
|
post:
|
|
description: ''
|
|
parameters:
|
|
- name: organizationId
|
|
in: path
|
|
required: true
|
|
schema:
|
|
type: string
|
|
responses:
|
|
'200':
|
|
description: OK
|
|
'400':
|
|
description: Bad Request
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
properties:
|
|
email:
|
|
example: any
|
|
delete:
|
|
description: ''
|
|
parameters:
|
|
- name: organizationId
|
|
in: path
|
|
required: true
|
|
schema:
|
|
type: string
|
|
responses:
|
|
'200':
|
|
description: OK
|
|
'400':
|
|
description: Bad Request
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
properties:
|
|
email:
|
|
example: any
|
|
/api/v1/organization/{organizationId}/customer-portal-session:
|
|
post:
|
|
description: ''
|
|
parameters:
|
|
- name: organizationId
|
|
in: path
|
|
required: true
|
|
schema:
|
|
type: string
|
|
responses:
|
|
'200':
|
|
description: OK
|
|
'400':
|
|
description: Bad Request
|
|
/api/v1/organization/{organizationId}/subscriptions:
|
|
get:
|
|
description: ''
|
|
parameters:
|
|
- name: organizationId
|
|
in: path
|
|
required: true
|
|
schema:
|
|
type: string
|
|
responses:
|
|
'200':
|
|
description: OK
|
|
'400':
|
|
description: Bad Request
|
|
/api/v1/workspace/{workspaceId}/keys:
|
|
get:
|
|
description: ''
|
|
parameters:
|
|
- name: workspaceId
|
|
in: path
|
|
required: true
|
|
schema:
|
|
type: string
|
|
responses:
|
|
'200':
|
|
description: OK
|
|
'400':
|
|
description: Bad Request
|
|
/api/v1/workspace/{workspaceId}/users:
|
|
get:
|
|
description: ''
|
|
parameters:
|
|
- name: workspaceId
|
|
in: path
|
|
required: true
|
|
schema:
|
|
type: string
|
|
responses:
|
|
'200':
|
|
description: OK
|
|
'400':
|
|
description: Bad Request
|
|
/api/v1/workspace/:
|
|
get:
|
|
description: ''
|
|
parameters: []
|
|
responses:
|
|
'200':
|
|
description: OK
|
|
'400':
|
|
description: Bad Request
|
|
post:
|
|
description: ''
|
|
parameters: []
|
|
responses:
|
|
'200':
|
|
description: OK
|
|
'400':
|
|
description: Bad Request
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
properties:
|
|
workspaceName:
|
|
example: any
|
|
organizationId:
|
|
example: any
|
|
/api/v1/workspace/{workspaceId}:
|
|
get:
|
|
description: ''
|
|
parameters:
|
|
- name: workspaceId
|
|
in: path
|
|
required: true
|
|
schema:
|
|
type: string
|
|
responses:
|
|
'200':
|
|
description: OK
|
|
'400':
|
|
description: Bad Request
|
|
delete:
|
|
description: ''
|
|
parameters:
|
|
- name: workspaceId
|
|
in: path
|
|
required: true
|
|
schema:
|
|
type: string
|
|
responses:
|
|
'200':
|
|
description: OK
|
|
'400':
|
|
description: Bad Request
|
|
/api/v1/workspace/{workspaceId}/name:
|
|
post:
|
|
description: ''
|
|
parameters:
|
|
- name: workspaceId
|
|
in: path
|
|
required: true
|
|
schema:
|
|
type: string
|
|
responses:
|
|
'200':
|
|
description: OK
|
|
'400':
|
|
description: Bad Request
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
properties:
|
|
name:
|
|
example: any
|
|
/api/v1/workspace/{workspaceId}/invite-signup:
|
|
post:
|
|
description: ''
|
|
parameters:
|
|
- name: workspaceId
|
|
in: path
|
|
required: true
|
|
schema:
|
|
type: string
|
|
responses:
|
|
'200':
|
|
description: OK
|
|
'400':
|
|
description: Bad Request
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
properties:
|
|
email:
|
|
example: any
|
|
/api/v1/workspace/{workspaceId}/integrations:
|
|
get:
|
|
description: ''
|
|
parameters:
|
|
- name: workspaceId
|
|
in: path
|
|
required: true
|
|
schema:
|
|
type: string
|
|
responses:
|
|
'200':
|
|
description: OK
|
|
'400':
|
|
description: Bad Request
|
|
/api/v1/workspace/{workspaceId}/authorizations:
|
|
get:
|
|
description: ''
|
|
parameters:
|
|
- name: workspaceId
|
|
in: path
|
|
required: true
|
|
schema:
|
|
type: string
|
|
responses:
|
|
'200':
|
|
description: OK
|
|
'400':
|
|
description: Bad Request
|
|
/api/v1/workspace/{workspaceId}/service-tokens:
|
|
get:
|
|
description: ''
|
|
parameters:
|
|
- name: workspaceId
|
|
in: path
|
|
required: true
|
|
schema:
|
|
type: string
|
|
responses:
|
|
'200':
|
|
description: OK
|
|
'400':
|
|
description: Bad Request
|
|
/api/v1/membership-org/membershipOrg/{membershipOrgId}/change-role:
|
|
post:
|
|
description: ''
|
|
parameters:
|
|
- name: membershipOrgId
|
|
in: path
|
|
required: true
|
|
schema:
|
|
type: string
|
|
responses:
|
|
'200':
|
|
description: OK
|
|
/api/v1/membership-org/{membershipOrgId}:
|
|
delete:
|
|
description: ''
|
|
parameters:
|
|
- name: membershipOrgId
|
|
in: path
|
|
required: true
|
|
schema:
|
|
type: string
|
|
responses:
|
|
'400':
|
|
description: Bad Request
|
|
/api/v1/membership/{workspaceId}/connect:
|
|
get:
|
|
description: ''
|
|
parameters:
|
|
- name: workspaceId
|
|
in: path
|
|
required: true
|
|
schema:
|
|
type: string
|
|
responses:
|
|
'200':
|
|
description: OK
|
|
'400':
|
|
description: Bad Request
|
|
/api/v1/membership/{membershipId}:
|
|
delete:
|
|
description: ''
|
|
parameters:
|
|
- name: membershipId
|
|
in: path
|
|
required: true
|
|
schema:
|
|
type: string
|
|
responses:
|
|
'200':
|
|
description: OK
|
|
'400':
|
|
description: Bad Request
|
|
/api/v1/membership/{membershipId}/change-role:
|
|
post:
|
|
description: ''
|
|
parameters:
|
|
- name: membershipId
|
|
in: path
|
|
required: true
|
|
schema:
|
|
type: string
|
|
responses:
|
|
'200':
|
|
description: OK
|
|
'400':
|
|
description: Bad Request
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
properties:
|
|
role:
|
|
example: any
|
|
/api/v1/key/{workspaceId}:
|
|
post:
|
|
description: ''
|
|
parameters:
|
|
- name: workspaceId
|
|
in: path
|
|
required: true
|
|
schema:
|
|
type: string
|
|
responses:
|
|
'200':
|
|
description: OK
|
|
'400':
|
|
description: Bad Request
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
properties:
|
|
key:
|
|
example: any
|
|
/api/v1/key/{workspaceId}/latest:
|
|
get:
|
|
description: ''
|
|
parameters:
|
|
- name: workspaceId
|
|
in: path
|
|
required: true
|
|
schema:
|
|
type: string
|
|
responses:
|
|
'200':
|
|
description: OK
|
|
'400':
|
|
description: Bad Request
|
|
/api/v1/invite-org/signup:
|
|
post:
|
|
description: ''
|
|
parameters: []
|
|
responses:
|
|
'200':
|
|
description: OK
|
|
'400':
|
|
description: Bad Request
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
properties:
|
|
organizationId:
|
|
example: any
|
|
inviteeEmail:
|
|
example: any
|
|
/api/v1/invite-org/verify:
|
|
post:
|
|
description: ''
|
|
parameters: []
|
|
responses:
|
|
'200':
|
|
description: OK
|
|
'400':
|
|
description: Bad Request
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
properties:
|
|
email:
|
|
example: any
|
|
code:
|
|
example: any
|
|
/api/v1/secret/{workspaceId}:
|
|
post:
|
|
description: ''
|
|
parameters:
|
|
- name: workspaceId
|
|
in: path
|
|
required: true
|
|
schema:
|
|
type: string
|
|
responses:
|
|
'200':
|
|
description: OK
|
|
'400':
|
|
description: Bad Request
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
properties:
|
|
secrets:
|
|
example: any
|
|
keys:
|
|
example: any
|
|
environment:
|
|
example: any
|
|
channel:
|
|
example: any
|
|
get:
|
|
description: ''
|
|
parameters:
|
|
- name: workspaceId
|
|
in: path
|
|
required: true
|
|
schema:
|
|
type: string
|
|
- name: environment
|
|
in: query
|
|
schema:
|
|
type: string
|
|
- name: channel
|
|
in: query
|
|
schema:
|
|
type: string
|
|
responses:
|
|
'200':
|
|
description: OK
|
|
'400':
|
|
description: Bad Request
|
|
/api/v1/secret/{workspaceId}/service-token:
|
|
get:
|
|
description: ''
|
|
parameters:
|
|
- name: workspaceId
|
|
in: path
|
|
required: true
|
|
schema:
|
|
type: string
|
|
- name: environment
|
|
in: query
|
|
schema:
|
|
type: string
|
|
- name: channel
|
|
in: query
|
|
schema:
|
|
type: string
|
|
responses:
|
|
'200':
|
|
description: OK
|
|
'400':
|
|
description: Bad Request
|
|
/api/v1/service-token/:
|
|
get:
|
|
description: ''
|
|
parameters: []
|
|
responses:
|
|
'200':
|
|
description: OK
|
|
post:
|
|
description: ''
|
|
parameters: []
|
|
responses:
|
|
'200':
|
|
description: OK
|
|
'400':
|
|
description: Bad Request
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
properties:
|
|
name:
|
|
example: any
|
|
workspaceId:
|
|
example: any
|
|
environment:
|
|
example: any
|
|
expiresIn:
|
|
example: any
|
|
publicKey:
|
|
example: any
|
|
encryptedKey:
|
|
example: any
|
|
nonce:
|
|
example: any
|
|
/api/v1/password/srp1:
|
|
post:
|
|
description: ''
|
|
parameters: []
|
|
responses:
|
|
'200':
|
|
description: OK
|
|
'400':
|
|
description: Bad Request
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
properties:
|
|
clientPublicKey:
|
|
example: any
|
|
/api/v1/password/change-password:
|
|
post:
|
|
description: ''
|
|
parameters: []
|
|
responses:
|
|
'200':
|
|
description: OK
|
|
'400':
|
|
description: Bad Request
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
properties:
|
|
clientProof:
|
|
example: any
|
|
encryptedPrivateKey:
|
|
example: any
|
|
iv:
|
|
example: any
|
|
tag:
|
|
example: any
|
|
salt:
|
|
example: any
|
|
verifier:
|
|
example: any
|
|
/api/v1/password/email/password-reset:
|
|
post:
|
|
description: ''
|
|
parameters: []
|
|
responses:
|
|
'200':
|
|
description: OK
|
|
'400':
|
|
description: Bad Request
|
|
'403':
|
|
description: Forbidden
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
properties:
|
|
email:
|
|
example: any
|
|
/api/v1/password/email/password-reset-verify:
|
|
post:
|
|
description: ''
|
|
parameters: []
|
|
responses:
|
|
'200':
|
|
description: OK
|
|
'400':
|
|
description: Bad Request
|
|
'403':
|
|
description: Forbidden
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
properties:
|
|
email:
|
|
example: any
|
|
code:
|
|
example: any
|
|
/api/v1/password/backup-private-key:
|
|
get:
|
|
description: ''
|
|
parameters: []
|
|
responses:
|
|
'200':
|
|
description: OK
|
|
'400':
|
|
description: Bad Request
|
|
post:
|
|
description: ''
|
|
parameters: []
|
|
responses:
|
|
'200':
|
|
description: OK
|
|
'400':
|
|
description: Bad Request
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
properties:
|
|
clientProof:
|
|
example: any
|
|
encryptedPrivateKey:
|
|
example: any
|
|
iv:
|
|
example: any
|
|
tag:
|
|
example: any
|
|
salt:
|
|
example: any
|
|
verifier:
|
|
example: any
|
|
/api/v1/password/password-reset:
|
|
post:
|
|
description: ''
|
|
parameters: []
|
|
responses:
|
|
'200':
|
|
description: OK
|
|
'400':
|
|
description: Bad Request
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
properties:
|
|
encryptedPrivateKey:
|
|
example: any
|
|
iv:
|
|
example: any
|
|
tag:
|
|
example: any
|
|
salt:
|
|
example: any
|
|
verifier:
|
|
example: any
|
|
/api/v1/stripe/webhook:
|
|
post:
|
|
description: ''
|
|
parameters:
|
|
- name: stripe-signature
|
|
in: header
|
|
schema:
|
|
type: string
|
|
responses:
|
|
'200':
|
|
description: OK
|
|
'400':
|
|
description: Bad Request
|
|
/api/v1/integration/{integrationId}:
|
|
patch:
|
|
description: ''
|
|
parameters:
|
|
- name: integrationId
|
|
in: path
|
|
required: true
|
|
schema:
|
|
type: string
|
|
responses:
|
|
'200':
|
|
description: OK
|
|
'400':
|
|
description: Bad Request
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
properties:
|
|
app:
|
|
example: any
|
|
environment:
|
|
example: any
|
|
isActive:
|
|
example: any
|
|
target:
|
|
example: any
|
|
context:
|
|
example: any
|
|
siteId:
|
|
example: any
|
|
delete:
|
|
description: ''
|
|
parameters:
|
|
- name: integrationId
|
|
in: path
|
|
required: true
|
|
schema:
|
|
type: string
|
|
responses:
|
|
'200':
|
|
description: OK
|
|
'400':
|
|
description: Bad Request
|
|
/api/v1/integration-auth/integration-options:
|
|
get:
|
|
description: ''
|
|
parameters: []
|
|
responses:
|
|
'200':
|
|
description: OK
|
|
/api/v1/integration-auth/oauth-token:
|
|
post:
|
|
description: ''
|
|
parameters: []
|
|
responses:
|
|
'200':
|
|
description: OK
|
|
'400':
|
|
description: Bad Request
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
properties:
|
|
workspaceId:
|
|
example: any
|
|
code:
|
|
example: any
|
|
integration:
|
|
example: any
|
|
/api/v1/integration-auth/{integrationAuthId}/apps:
|
|
get:
|
|
description: ''
|
|
parameters:
|
|
- name: integrationAuthId
|
|
in: path
|
|
required: true
|
|
schema:
|
|
type: string
|
|
responses:
|
|
'200':
|
|
description: OK
|
|
'400':
|
|
description: Bad Request
|
|
/api/v1/integration-auth/{integrationAuthId}:
|
|
delete:
|
|
description: ''
|
|
parameters:
|
|
- name: integrationAuthId
|
|
in: path
|
|
required: true
|
|
schema:
|
|
type: string
|
|
responses:
|
|
'200':
|
|
description: OK
|
|
'400':
|
|
description: Bad Request
|
|
/api/v2/workspace/{workspaceId}/secrets:
|
|
post:
|
|
description: ''
|
|
parameters:
|
|
- name: workspaceId
|
|
in: path
|
|
required: true
|
|
schema:
|
|
type: string
|
|
responses:
|
|
'200':
|
|
description: OK
|
|
'400':
|
|
description: Bad Request
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
properties:
|
|
secrets:
|
|
example: any
|
|
keys:
|
|
example: any
|
|
environment:
|
|
example: any
|
|
channel:
|
|
example: any
|
|
get:
|
|
description: ''
|
|
parameters:
|
|
- name: workspaceId
|
|
in: path
|
|
required: true
|
|
schema:
|
|
type: string
|
|
- name: environment
|
|
in: query
|
|
schema:
|
|
type: string
|
|
- name: channel
|
|
in: query
|
|
schema:
|
|
type: string
|
|
responses:
|
|
'200':
|
|
description: OK
|
|
'400':
|
|
description: Bad Request
|
|
/api/v2/workspace/{workspaceId}/encrypted-key:
|
|
get:
|
|
description: ''
|
|
parameters:
|
|
- name: workspaceId
|
|
in: path
|
|
required: true
|
|
schema:
|
|
type: string
|
|
responses:
|
|
'200':
|
|
description: OK
|
|
'400':
|
|
description: Bad Request
|
|
/api/v2/workspace/{workspaceId}/service-token-data:
|
|
get:
|
|
description: ''
|
|
parameters:
|
|
- name: workspaceId
|
|
in: path
|
|
required: true
|
|
schema:
|
|
type: string
|
|
responses:
|
|
'200':
|
|
description: OK
|
|
'400':
|
|
description: Bad Request
|
|
/api/v2/secret/batch-create/workspace/{workspaceId}/environment/{environment}:
|
|
post:
|
|
description: ''
|
|
parameters:
|
|
- name: workspaceId
|
|
in: path
|
|
required: true
|
|
schema:
|
|
type: string
|
|
- name: environment
|
|
in: path
|
|
required: true
|
|
schema:
|
|
type: string
|
|
responses:
|
|
'200':
|
|
description: OK
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
properties:
|
|
secrets:
|
|
example: any
|
|
/api/v2/secret/workspace/{workspaceId}/environment/{environment}:
|
|
post:
|
|
description: ''
|
|
parameters:
|
|
- name: workspaceId
|
|
in: path
|
|
required: true
|
|
schema:
|
|
type: string
|
|
- name: environment
|
|
in: path
|
|
required: true
|
|
schema:
|
|
type: string
|
|
responses:
|
|
'200':
|
|
description: OK
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
properties:
|
|
secret:
|
|
example: any
|
|
/api/v2/secret/workspace/{workspaceId}:
|
|
get:
|
|
description: ''
|
|
parameters:
|
|
- name: workspaceId
|
|
in: path
|
|
required: true
|
|
schema:
|
|
type: string
|
|
- name: environment
|
|
in: query
|
|
schema:
|
|
type: string
|
|
responses:
|
|
'200':
|
|
description: OK
|
|
/api/v2/secret/{secretId}:
|
|
get:
|
|
description: ''
|
|
parameters:
|
|
- name: secretId
|
|
in: path
|
|
required: true
|
|
schema:
|
|
type: string
|
|
responses:
|
|
'200':
|
|
description: OK
|
|
delete:
|
|
description: ''
|
|
parameters:
|
|
- name: secretId
|
|
in: path
|
|
required: true
|
|
schema:
|
|
type: string
|
|
responses:
|
|
'200':
|
|
description: OK
|
|
/api/v2/secret/batch/workspace/{workspaceId}/environment/{environmentName}:
|
|
delete:
|
|
description: ''
|
|
parameters:
|
|
- name: workspaceId
|
|
in: path
|
|
required: true
|
|
schema:
|
|
type: string
|
|
- name: environmentName
|
|
in: path
|
|
required: true
|
|
schema:
|
|
type: string
|
|
responses:
|
|
'200':
|
|
description: OK
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
properties:
|
|
secretIds:
|
|
example: any
|
|
/api/v2/secret/batch-modify/workspace/{workspaceId}/environment/{environmentName}:
|
|
patch:
|
|
description: ''
|
|
parameters:
|
|
- name: workspaceId
|
|
in: path
|
|
required: true
|
|
schema:
|
|
type: string
|
|
- name: environmentName
|
|
in: path
|
|
required: true
|
|
schema:
|
|
type: string
|
|
responses:
|
|
'200':
|
|
description: OK
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
properties:
|
|
secrets:
|
|
example: any
|
|
/api/v2/secret/workspace/{workspaceId}/environment/{environmentName}:
|
|
patch:
|
|
description: ''
|
|
parameters:
|
|
- name: workspaceId
|
|
in: path
|
|
required: true
|
|
schema:
|
|
type: string
|
|
- name: environmentName
|
|
in: path
|
|
required: true
|
|
schema:
|
|
type: string
|
|
responses:
|
|
'200':
|
|
description: OK
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
properties:
|
|
secret:
|
|
example: any
|
|
/api/v2/secrets/:
|
|
post:
|
|
description: ''
|
|
parameters: []
|
|
responses:
|
|
'200':
|
|
description: OK
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
properties:
|
|
secrets:
|
|
example: any
|
|
workspaceId:
|
|
example: any
|
|
environment:
|
|
example: any
|
|
get:
|
|
description: ''
|
|
parameters:
|
|
- name: workspaceId
|
|
in: query
|
|
schema:
|
|
type: string
|
|
- name: environment
|
|
in: query
|
|
schema:
|
|
type: string
|
|
responses:
|
|
'200':
|
|
description: OK
|
|
patch:
|
|
description: ''
|
|
parameters: []
|
|
responses:
|
|
'200':
|
|
description: OK
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
properties:
|
|
secrets:
|
|
example: any
|
|
delete:
|
|
description: ''
|
|
parameters: []
|
|
responses:
|
|
'200':
|
|
description: OK
|
|
/api/v2/service-token/:
|
|
get:
|
|
description: ''
|
|
parameters: []
|
|
responses:
|
|
'200':
|
|
description: OK
|
|
'400':
|
|
description: Bad Request
|
|
post:
|
|
description: ''
|
|
parameters: []
|
|
responses:
|
|
'200':
|
|
description: OK
|
|
'400':
|
|
description: Bad Request
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
properties:
|
|
name:
|
|
example: any
|
|
workspaceId:
|
|
example: any
|
|
environment:
|
|
example: any
|
|
encryptedKey:
|
|
example: any
|
|
iv:
|
|
example: any
|
|
tag:
|
|
example: any
|
|
expiresIn:
|
|
example: any
|
|
/api/v2/service-token/{serviceTokenDataId}:
|
|
delete:
|
|
description: ''
|
|
parameters:
|
|
- name: serviceTokenDataId
|
|
in: path
|
|
required: true
|
|
schema:
|
|
type: string
|
|
responses:
|
|
'200':
|
|
description: OK
|
|
'400':
|
|
description: Bad Request
|
|
/api/v2/api-key-data/:
|
|
get:
|
|
description: ''
|
|
parameters: []
|
|
responses:
|
|
'200':
|
|
description: OK
|
|
'400':
|
|
description: Bad Request
|
|
post:
|
|
description: ''
|
|
parameters: []
|
|
responses:
|
|
'200':
|
|
description: OK
|
|
'400':
|
|
description: Bad Request
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
properties:
|
|
name:
|
|
example: any
|
|
expiresIn:
|
|
example: any
|
|
/api/v2/api-key-data/{apiKeyDataId}:
|
|
delete:
|
|
description: ''
|
|
parameters:
|
|
- name: apiKeyDataId
|
|
in: path
|
|
required: true
|
|
schema:
|
|
type: string
|
|
responses:
|
|
'200':
|
|
description: OK
|
|
'400':
|
|
description: Bad Request
|
|
/api/status:
|
|
get:
|
|
description: ''
|
|
parameters: []
|
|
responses:
|
|
'200':
|
|
description: OK
|
|
components:
|
|
schemas:
|
|
secret:
|
|
type: object
|
|
properties:
|
|
type:
|
|
type: string
|
|
example: object
|
|
properties:
|
|
type: object
|
|
properties:
|
|
test:
|
|
type: object
|
|
properties:
|
|
type:
|
|
type: string
|
|
example: integer
|
|
description:
|
|
type: string
|
|
example: '123'
|
|
securitySchemes:
|
|
bearerAuth:
|
|
type: http
|
|
scheme: bearer
|
|
bearerFormat: JWT
|