Logout

coder · mtojek · Jan 11, 2023 · Dec 22, 2022 · Jan 2, 2023 · Jan 2, 2023
commit 928542560f56a60be96e263cb4dc48f873ba6ca0
diff --git a/coderd/apidoc/docs.go b/coderd/apidoc/docs.go
@@ -2029,6 +2029,31 @@ const docTemplate = `{
                 }
             }
         },
+        "/users/logout": {
+            "post": {
+                "security": [
+                    {
+                        "CoderSessionToken": []
+                    }
+                ],
+                "produces": [
+                    "application/json"
+                ],
+                "tags": [
+                    "Users"
+                ],
+                "summary": "Log out user",
+                "operationId": "log-out-user",
+                "responses": {
+                    "200": {
+                        "description": "OK",
+                        "schema": {
+                            "$ref": "#/definitions/codersdk.Response"
+                        }
+                    }
+                }
+            }
+        },
         "/users/oauth2/github/callback": {
             "get": {
                 "security": [
@@ -2073,6 +2098,34 @@ const docTemplate = `{
                 }
             }
         },
+        "/users/roles": {
+            "get": {
+                "security": [
+                    {
+                        "CoderSessionToken": []
+                    }
+                ],
+                "produces": [
+                    "application/json"
+                ],
+                "tags": [
+                    "Members"
+                ],
+                "summary": "Get site member roles",
+                "operationId": "get-site-member-roles",
+                "responses": {
+                    "200": {
+                        "description": "OK",
+                        "schema": {
+                            "type": "array",
+                            "items": {
+                                "$ref": "#/definitions/codersdk.AssignableRoles"
+                            }
+                        }
+                    }
+                }
+            }
+        },
         "/users/{user}/workspace/{workspacename}": {
             "get": {
                 "security": [

diff --git a/coderd/apidoc/swagger.json b/coderd/apidoc/swagger.json
@@ -1785,6 +1785,27 @@
         }
       }
     },
+    "/users/logout": {
+      "post": {
+        "security": [
+          {
+            "CoderSessionToken": []
+          }
+        ],
+        "produces": ["application/json"],
+        "tags": ["Users"],
+        "summary": "Log out user",
+        "operationId": "log-out-user",
+        "responses": {
+          "200": {
+            "description": "OK",
+            "schema": {
+              "$ref": "#/definitions/codersdk.Response"
+            }
+          }
+        }
+      }
+    },
     "/users/oauth2/github/callback": {
       "get": {
         "security": [
@@ -1821,6 +1842,30 @@
         }
       }
     },
+    "/users/roles": {
+      "get": {
+        "security": [
+          {
+            "CoderSessionToken": []
+          }
+        ],
+        "produces": ["application/json"],
+        "tags": ["Members"],
+        "summary": "Get site member roles",
+        "operationId": "get-site-member-roles",
+        "responses": {
+          "200": {
+            "description": "OK",
+            "schema": {
+              "type": "array",
+              "items": {
+                "$ref": "#/definitions/codersdk.AssignableRoles"
+              }
+            }
+          }
+        }
+      }
+    },
     "/users/{user}/workspace/{workspacename}": {
       "get": {
         "security": [

diff --git a/coderd/roles.go b/coderd/roles.go
@@ -11,6 +11,14 @@ import (
 )
 
 // assignableSiteRoles returns all site wide roles that can be assigned.
+//
+// @Summary Get site member roles
+// @ID get-site-member-roles
+// @Security CoderSessionToken
+// @Produce json
+// @Tags Members
+// @Success 200 {array} codersdk.AssignableRoles
+// @Router /users/roles [get]
 func (api *API) assignableSiteRoles(rw http.ResponseWriter, r *http.Request) {
 	ctx := r.Context()
 	actorRoles := httpmw.UserAuthorization(r)
@@ -23,6 +31,8 @@ func (api *API) assignableSiteRoles(rw http.ResponseWriter, r *http.Request) {
 	httpapi.Write(ctx, rw, http.StatusOK, assignableRoles(actorRoles.Roles, roles))
 }
 
+// assignableSiteRoles returns all org wide roles that can be assigned.
+//
 // @Summary Get member roles by organization
 // @ID get-member-roles-by-organization
 // @Security CoderSessionToken
@@ -31,8 +41,6 @@ func (api *API) assignableSiteRoles(rw http.ResponseWriter, r *http.Request) {
 // @Param organization path string true "Organization ID" format(uuid)
 // @Success 200 {array} codersdk.AssignableRoles
 // @Router /organizations/{organization}/members/roles [get]
-//
-// assignableSiteRoles returns all site wide roles that can be assigned.
 func (api *API) assignableOrgRoles(rw http.ResponseWriter, r *http.Request) {
 	ctx := r.Context()
 	organization := httpmw.OrganizationParam(r)

diff --git a/coderd/users.go b/coderd/users.go
@@ -970,6 +970,14 @@ func (api *API) postLogin(rw http.ResponseWriter, r *http.Request) {
 }
 
 // Clear the user's session cookie.
+//
+// @Summary Log out user
+// @ID log-out-user
+// @Security CoderSessionToken
+// @Produce json
+// @Tags Users
+// @Success 200 {object} codersdk.Response
+// @Router /users/logout [post]
 func (api *API) postLogout(rw http.ResponseWriter, r *http.Request) {
 	ctx := r.Context()
 	// Get a blank token cookie.

diff --git a/docs/api/members.md b/docs/api/members.md
@@ -110,3 +110,49 @@ curl -X PUT http://coder-server:8080/api/v2/organizations/{organization}/members
 | 200    | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK          | [codersdk.OrganizationMember](schemas.md#codersdkorganizationmember) |
 
 To perform this operation, you must be authenticated. [Learn more](authentication.md).
+
+## Get site member roles
+
+### Code samples
+
+```shell
+# Example request using curl
+curl -X GET http://coder-server:8080/api/v2/users/roles \
+  -H 'Accept: application/json' \
+  -H 'Coder-Session-Token: API_KEY'
+```
+
+`GET /users/roles`
+
+### Example responses
+
+> 200 Response
+
+```json
+[
+  {
+    "assignable": true,
+    "display_name": "string",
+    "name": "string"
+  }
+]
+```
+
+### Responses
+
+| Status | Meaning                                                 | Description | Schema                                                                  |
+| ------ | ------------------------------------------------------- | ----------- | ----------------------------------------------------------------------- |
+| 200    | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK          | array of [codersdk.AssignableRoles](schemas.md#codersdkassignableroles) |
+
+<h3 id="get-site-member-roles-responseschema">Response Schema</h3>
+
+Status Code **200**
+
+| Name             | Type    | Required | Restrictions | Description |
+| ---------------- | ------- | -------- | ------------ | ----------- |
+| `[array item]`   | array   | false    |              |             |
+| `» assignable`   | boolean | false    |              |             |
+| `» display_name` | string  | false    |              |             |
+| `» name`         | string  | false    |              |             |
+
+To perform this operation, you must be authenticated. [Learn more](authentication.md).
diff --git a/docs/api/users.md b/docs/api/users.md
@@ -243,6 +243,44 @@ curl -X POST http://coder-server:8080/api/v2/users/first \
 
 To perform this operation, you must be authenticated. [Learn more](authentication.md).
 
+## Log out user
+
+### Code samples
+
+```shell
+# Example request using curl
+curl -X POST http://coder-server:8080/api/v2/users/logout \
+  -H 'Accept: application/json' \
+  -H 'Coder-Session-Token: API_KEY'
+```
+
+`POST /users/logout`
+
+### Example responses
+
+> 200 Response
+
+```json
+{
+  "detail": "string",
+  "message": "string",
+  "validations": [
+    {
+      "detail": "string",
+      "field": "string"
+    }
+  ]
+}
+```
+
+### Responses
+
+| Status | Meaning                                                 | Description | Schema                                           |
+| ------ | ------------------------------------------------------- | ----------- | ------------------------------------------------ |
+| 200    | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK          | [codersdk.Response](schemas.md#codersdkresponse) |
+
+To perform this operation, you must be authenticated. [Learn more](authentication.md).
+
 ## OAuth 2.0 GitHub Callback
 
 ### Code samples