diff --git a/pkg/api/README.md b/pkg/api/README.md index 08358933378..b3aee79ff7c 100644 --- a/pkg/api/README.md +++ b/pkg/api/README.md @@ -12,6 +12,8 @@ Developers modifying the HTTP API endpoints need to make sure to add the necessa The following route defines a `PATCH` endpoint under the `/serviceaccounts/{serviceAccountId}` path with tag `service_accounts` (used for grouping together several routes) and operation ID `updateServiceAccount` (used for uniquely identifying routes and associate parameters and response with them). +> For enterprise endpoints make sure you add the `enterprise` tag as well. + ```go // swagger:route PATCH /serviceaccounts/{serviceAccountId} service_accounts updateServiceAccount diff --git a/public/api-enterprise-spec.json b/public/api-enterprise-spec.json index d2c775085d5..cdd858d9dcc 100644 --- a/public/api-enterprise-spec.json +++ b/public/api-enterprise-spec.json @@ -2211,6 +2211,113 @@ } } }, + "/scim/users/": { + "get": { + "tags": [ + "users", + "enterprise" + ], + "summary": "Fetches all users in UserSchema format.", + "operationId": "getUsers", + "responses": { + "200": { + "$ref": "#/responses/getUsers" + }, + "400": { + "$ref": "#/responses/badRequestError" + }, + "401": { + "$ref": "#/responses/unauthorisedError" + }, + "404": { + "$ref": "#/responses/notFoundError" + }, + "500": { + "$ref": "#/responses/internalServerError" + } + } + }, + "post": { + "tags": [ + "users", + "enterprise" + ], + "summary": "Creates user.", + "operationId": "createUser", + "responses": { + "200": { + "$ref": "#/responses/okResponse" + }, + "400": { + "$ref": "#/responses/badRequestError" + }, + "401": { + "$ref": "#/responses/unauthorisedError" + }, + "403": { + "$ref": "#/responses/forbiddenError" + }, + "409": { + "$ref": "#/responses/conflictError" + }, + "500": { + "$ref": "#/responses/internalServerError" + } + } + }, + "delete": { + "tags": [ + "user", + "enterprise" + ], + "summary": "Deletes user.", + "operationId": "deleteUser", + "responses": { + "200": { + "$ref": "#/responses/okResponse" + }, + "400": { + "$ref": "#/responses/badRequestError" + }, + "401": { + "$ref": "#/responses/unauthorisedError" + }, + "404": { + "$ref": "#/responses/notFoundError" + }, + "500": { + "$ref": "#/responses/internalServerError" + } + } + } + }, + "/scim/users/:id": { + "get": { + "tags": [ + "user", + "enterprise" + ], + "summary": "Gets user by id.", + "operationId": "getUser", + "responses": { + "200": { + "$ref": "#/responses/okResponse" + }, + "400": { + "$ref": "#/responses/badRequestError" + }, + "401": { + "$ref": "#/responses/unauthorisedError" + }, + "403": { + "$ref": "#/responses/forbiddenError" + }, + "500": { + "$ref": "#/responses/internalServerError" + } + } + } + }, "/teams/{teamId}/groups": { "get": { "tags": [ diff --git a/public/api-merged.json b/public/api-merged.json index 1978029ed6c..e9b63723b69 100644 --- a/public/api-merged.json +++ b/public/api-merged.json @@ -8609,7 +8609,8 @@ "/scim/users/": { "get": { "tags": [ - "users" + "users", + "enterprise" ], "summary": "Fetches all users in UserSchema format.", "operationId": "getUsers", @@ -8633,7 +8634,8 @@ }, "post": { "tags": [ - "users" + "users", + "enterprise" ], "summary": "Creates user.", "operationId": "createUser", @@ -8660,7 +8662,8 @@ }, "delete": { "tags": [ - "user" + "user", + "enterprise" ], "summary": "Deletes user.", "operationId": "deleteUser", @@ -8686,7 +8689,8 @@ "/scim/users/:id": { "get": { "tags": [ - "user" + "user", + "enterprise" ], "summary": "Gets user by id.", "operationId": "getUser", diff --git a/public/openapi3.json b/public/openapi3.json index 6f003b70069..117b43ca050 100644 --- a/public/openapi3.json +++ b/public/openapi3.json @@ -22639,7 +22639,8 @@ }, "summary": "Deletes user.", "tags": [ - "user" + "user", + "enterprise" ] }, "get": { @@ -22663,7 +22664,8 @@ }, "summary": "Fetches all users in UserSchema format.", "tags": [ - "users" + "users", + "enterprise" ] }, "post": { @@ -22690,7 +22692,8 @@ }, "summary": "Creates user.", "tags": [ - "users" + "users", + "enterprise" ] } }, @@ -22716,7 +22719,8 @@ }, "summary": "Gets user by id.", "tags": [ - "user" + "user", + "enterprise" ] } },