Add available user roles listing endpoint

Scalingo · Jan 7, 2025 · 588271e · 588271e
1 parent 57451b3
commit 588271e
Show file tree

Hide file tree

Showing 2 changed files with 21 additions and 0 deletions.
diff --git a/src/Users/index.ts b/src/Users/index.ts
@@ -64,6 +64,16 @@ export class Users {
         .post(`/users/delete/${deletionId}/confirm`, { deletion: params }),
     );
   }
+
+  /**
+   * List all known roles.
+   */
+  roles(): Promise<string[]> {
+    return unpackData(
+      this._client.authApiClient().get("/users/roles"),
+      "roles",
+    );
+  }
 }
 
 export default Users;
diff --git a/test/Users/index.test.js b/test/Users/index.test.js
@@ -62,3 +62,14 @@ describe("Users#confirmAccountDeletion", () => {
     },
   );
 });
+
+describe("Users#roles", () => {
+  testGetter(
+    "https://auth.scalingo.com/v1/users/roles",
+    null,
+    "roles",
+    (client) => {
+      return new Users(client).roles();
+    },
+  );
+});