Update existing endpoints in API reference to support Identities, update Identities docs

This commit is contained in:
Tuan Dang
2023-12-11 20:01:32 +07:00
parent f3e8ef1537
commit 5f29562fad
40 changed files with 924 additions and 333 deletions

View File

@@ -9,6 +9,35 @@ servers:
- url: http://localhost:8080
description: Local server
paths:
/api/v1/identities/:
post:
description: ''
responses:
'200':
description: OK
/api/v1/identities/{identityId}:
patch:
description: ''
parameters:
- name: identityId
in: path
required: true
schema:
type: string
responses:
'200':
description: OK
delete:
description: ''
parameters:
- name: identityId
in: path
required: true
schema:
type: string
responses:
'200':
description: OK
/api/v1/secret/{secretId}/secret-versions:
get:
summary: Return secret versions
@@ -110,7 +139,21 @@ paths:
required: true
schema:
type: string
description: ID of project
description: ID of project where to get secret snapshots for
- name: environment
description: Slug of environment where to get secret snapshots for
required: true
in: query
schema:
type: string
- name: directory
description: >-
Path where to get secret snapshots for like / or /foo/bar. Default
is /
required: false
in: query
schema:
type: string
- name: offset
description: Number of secret snapshots to skip
required: false
@@ -138,6 +181,7 @@ paths:
description: Project secret snapshots
security:
- apiKeyAuth: []
bearerAuth: []
/api/v1/workspace/{workspaceId}/secret-snapshots/count:
get:
description: ''
@@ -164,7 +208,7 @@ paths:
required: true
schema:
type: string
description: ID of project
description: ID of project where to roll back
responses:
'200':
description: OK
@@ -180,6 +224,7 @@ paths:
description: Secrets rolled back to
security:
- apiKeyAuth: []
bearerAuth: []
requestBody:
required: true
content:
@@ -187,6 +232,12 @@ paths:
schema:
type: object
properties:
environment:
type: string
description: Slug of environment where to roll back
directory:
type: string
description: Path where to roll back for like / or /foo/bar. Default is /
version:
type: integer
description: Version of secret snapshot to roll back to
@@ -604,51 +655,6 @@ paths:
responses:
'200':
description: OK
/api/v3/service-token/me/key:
get:
description: ''
responses:
'200':
description: OK
/api/v3/service-token/me/token:
post:
description: ''
responses:
'200':
description: OK
/api/v3/service-token/:
post:
description: ''
responses:
'200':
description: OK
'400':
description: Bad Request
/api/v3/service-token/{serviceTokenDataId}:
patch:
description: ''
parameters:
- name: serviceTokenDataId
in: path
required: true
schema:
type: string
responses:
'200':
description: OK
'400':
description: Bad Request
delete:
description: ''
parameters:
- name: serviceTokenDataId
in: path
required: true
schema:
type: string
responses:
'200':
description: OK
/api/v1/secret-rotation-providers/{workspaceId}:
get:
description: ''
@@ -749,6 +755,101 @@ paths:
responses:
'200':
description: OK
/api/v1/auth/token/renew:
post:
description: ''
responses:
'200':
description: OK
/api/v1/auth/universal-auth/login:
post:
description: ''
parameters:
- name: user-agent
in: header
schema:
type: string
responses:
'200':
description: OK
/api/v1/auth/universal-auth/identities/{identityId}:
post:
description: ''
parameters:
- name: identityId
in: path
required: true
schema:
type: string
responses:
'200':
description: OK
'400':
description: Bad Request
patch:
description: ''
parameters:
- name: identityId
in: path
required: true
schema:
type: string
responses:
'200':
description: OK
'400':
description: Bad Request
get:
description: ''
parameters:
- name: identityId
in: path
required: true
schema:
type: string
responses:
'200':
description: OK
/api/v1/auth/universal-auth/identities/{identityId}/client-secrets:
post:
description: ''
parameters:
- name: identityId
in: path
required: true
schema:
type: string
responses:
'200':
description: OK
get:
description: ''
parameters:
- name: identityId
in: path
required: true
schema:
type: string
responses:
'200':
description: OK
/api/v1/auth/universal-auth/identities/{identityId}/client-secrets/{clientSecretId}/revoke:
post:
description: ''
parameters:
- name: identityId
in: path
required: true
schema:
type: string
- name: clientSecretId
in: path
required: true
schema:
type: string
responses:
'200':
description: OK
/api/v1/admin/config:
get:
description: ''
@@ -1106,6 +1207,8 @@ paths:
responses:
'200':
description: OK
'400':
description: Bad Request
/api/v1/key/{workspaceId}:
post:
description: ''
@@ -2560,8 +2663,8 @@ paths:
description: OK
/api/v2/organizations/{organizationId}/memberships:
get:
summary: Return organization memberships
description: Return organization memberships
summary: Return organization user memberships
description: Return organization user memberships
parameters:
- name: organizationId
in: path
@@ -2584,10 +2687,11 @@ paths:
description: Memberships of organization
security:
- apiKeyAuth: []
bearerAuth: []
/api/v2/organizations/{organizationId}/memberships/{membershipId}:
patch:
summary: Update organization membership
description: Update organization membership
summary: Update organization user membership
description: Update organization user membership
parameters:
- name: organizationId
in: path
@@ -2612,8 +2716,11 @@ paths:
membership:
$ref: '#/components/schemas/MembershipOrg'
description: Updated organization membership
'400':
description: Bad Request
security:
- apiKeyAuth: []
bearerAuth: []
requestBody:
required: true
content:
@@ -2627,8 +2734,8 @@ paths:
Role of organization membership - either owner, admin, or
member
delete:
summary: Delete organization membership
description: Delete organization membership
summary: Delete organization user membership
description: Delete organization user membership
parameters:
- name: organizationId
in: path
@@ -2655,6 +2762,7 @@ paths:
description: Deleted organization membership
security:
- apiKeyAuth: []
bearerAuth: []
/api/v2/organizations/{organizationId}/workspaces:
get:
summary: Return projects in organization that user is part of
@@ -2699,6 +2807,18 @@ paths:
responses:
'200':
description: OK
/api/v2/organizations/{organizationId}/identity-memberships:
get:
description: ''
parameters:
- name: organizationId
in: path
required: true
schema:
type: string
responses:
'200':
description: OK
/api/v2/workspace/{workspaceId}/memberships:
post:
description: ''
@@ -2712,8 +2832,8 @@ paths:
'200':
description: OK
get:
summary: Return project memberships
description: Return project memberships
summary: Return project user memberships
description: Return project user memberships
parameters:
- name: workspaceId
in: path
@@ -2736,6 +2856,7 @@ paths:
description: Memberships of project
security:
- apiKeyAuth: []
bearerAuth: []
/api/v2/workspace/{workspaceId}/environments:
post:
summary: Create environment
@@ -3031,8 +3152,8 @@ paths:
description: OK
/api/v2/workspace/{workspaceId}/memberships/{membershipId}:
patch:
summary: Update project membership
description: Update project membership
summary: Update project user membership
description: Update project user membership
parameters:
- name: workspaceId
in: path
@@ -3059,6 +3180,7 @@ paths:
description: Updated membership
security:
- apiKeyAuth: []
bearerAuth: []
requestBody:
required: true
content:
@@ -3070,8 +3192,8 @@ paths:
type: string
description: Role of membership - either admin or member
delete:
summary: Delete project membership
description: Delete project membership
summary: Delete project user membership
description: Delete project user membership
parameters:
- name: workspaceId
in: path
@@ -3098,6 +3220,7 @@ paths:
description: Deleted membership
security:
- apiKeyAuth: []
bearerAuth: []
/api/v2/workspace/{workspaceId}/auto-capitalization:
patch:
description: ''
@@ -3110,6 +3233,67 @@ paths:
responses:
'200':
description: OK
/api/v2/workspace/{workspaceId}/identity-memberships/{identityId}:
post:
description: ''
parameters:
- name: workspaceId
in: path
required: true
schema:
type: string
- name: identityId
in: path
required: true
schema:
type: string
responses:
'200':
description: OK
patch:
description: ''
parameters:
- name: workspaceId
in: path
required: true
schema:
type: string
- name: identityId
in: path
required: true
schema:
type: string
responses:
'200':
description: OK
delete:
description: ''
parameters:
- name: workspaceId
in: path
required: true
schema:
type: string
- name: identityId
in: path
required: true
schema:
type: string
responses:
'200':
description: OK
/api/v2/workspace/{workspaceId}/identity-memberships:
get:
description: ''
parameters:
- name: workspaceId
in: path
required: true
schema:
type: string
responses:
'200':
description: OK
/api/v2/secret/batch-create/workspace/{workspaceId}/environment/{environment}:
post:
description: ''
@@ -3842,18 +4026,6 @@ paths:
responses:
'200':
description: OK
/api/v3/workspaces/{workspaceId}/service-token:
get:
description: ''
parameters:
- name: workspaceId
in: path
required: true
schema:
type: string
responses:
'200':
description: OK
/api/v3/signup/complete-account/signup:
post:
description: ''
@@ -4424,7 +4596,7 @@ components:
type: http
scheme: bearer
bearerFormat: JWT
description: A service token in Infisical
description: An access token in Infisical
apiKeyAuth:
type: apiKey
in: header