Skip to content

Commit 27f5ff2

Browse files
coadlercoadler
authored
chore: correctly document SCIM authentication (coder#15234)
1 parent 900e2cd commit 27f5ff2

File tree

5 files changed

+30
-16
lines changed

5 files changed

+30
-16
lines changed

‎coderd/apidoc/docs.go

Lines changed: 9 additions & 4 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎coderd/apidoc/swagger.json

Lines changed: 9 additions & 4 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎coderd/coderd.go

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -271,6 +271,10 @@ type Options struct {
271271

272272
// @BasePath /api/v2
273273

274+
// @securitydefinitions.apiKey Authorization
275+
// @in header
276+
// @name Authorizaiton
277+
274278
// @securitydefinitions.apiKey CoderSessionToken
275279
// @in header
276280
// @name Coder-Session-Token

‎docs/reference/api/enterprise.md

Lines changed: 4 additions & 4 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎enterprise/coderd/scim.go

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ func (api *API) scimVerifyAuthHeader(r *http.Request) bool {
4040
//
4141
// @Summary SCIM 2.0: Get users
4242
// @ID scim-get-users
43-
// @Security CoderSessionToken
43+
// @Security Authorization
4444
// @Produce application/scim+json
4545
// @Tags Enterprise
4646
// @Success 200
@@ -67,7 +67,7 @@ func (api *API) scimGetUsers(rw http.ResponseWriter, r *http.Request) {
6767
//
6868
// @Summary SCIM 2.0: Get user by ID
6969
// @ID scim-get-user-by-id
70-
// @Security CoderSessionToken
70+
// @Security Authorization
7171
// @Produce application/scim+json
7272
// @Tags Enterprise
7373
// @Param id path string true "User ID" format(uuid)
@@ -118,7 +118,7 @@ var SCIMAuditAdditionalFields = map[string]string{
118118
//
119119
// @Summary SCIM 2.0: Create new user
120120
// @ID scim-create-new-user
121-
// @Security CoderSessionToken
121+
// @Security Authorization
122122
// @Produce json
123123
// @Tags Enterprise
124124
// @Param request body coderd.SCIMUser true "New user"
@@ -254,7 +254,7 @@ func (api *API) scimPostUser(rw http.ResponseWriter, r *http.Request) {
254254
//
255255
// @Summary SCIM 2.0: Update user account
256256
// @ID scim-update-user-status
257-
// @Security CoderSessionToken
257+
// @Security Authorization
258258
// @Produce application/scim+json
259259
// @Tags Enterprise
260260
// @Param id path string true "User ID" format(uuid)

0 commit comments

Comments
 (0)