Skip to content

Allow List API

Manage the Gamma allow list.

Name Value
API Key Type ALLOW_LIST
Base URL https://auth.chalmers.it/api/allow-list/v1
API Controller AllowListV1ApiController

What is the allow list?

The allow list is a whitelist of cids (Chalmers IDs) which are allowed to create a Gamma account. This is to limit Gamma account creation to members of the Software Engineering Student Division (IT).

When a new year of students enroll at the Software Engineering programme their cids are added to the allow list and they are allowed to create Gamma accounts.

Types

These are the types used in the Allow List API.

Success Response

name: string # Class name of the response
code: int # HTTP status code
Example
{
  "name": "ALLOW_LIST_ADDED_RESPONSE",
  "code": 200
}

Endpoints Reference

The Allow List API is currently hosted at https://auth.chalmers.it/api/allow-list/v1 and all endpoints in this section are relative to this URL.

GET /

Get the list of CIDs in the allow list.

Return type: String list

Example

Click to show example request and response

Request

GET /

Response

[
  "janed",
  "smithj"
]

POST /

Add users to the allow list.

Return type: Success Response

Body

The request body is a list of the CIDs to add to the allow list.

Example
[
  "smithj",
  "bloggsj"
]

Errors

206 Partial Content — Failed to add some users

One or more users could not be added to the allow list. The CIDs of the users who failed to be added are returned in the response body.

Response type: String list

Example

Click to show example request and response

Request

POST /

Request body:

[
  "smithj",
  "bloggsj"
]

Response (Success)

{
  "name": "ALLOW_LIST_ADDED_RESPONSE",
  "code": 200
}

Response (Failed)

HTTP status code: 206 Partial Content

[
  "smithj"
]

Last modified on: 2026-04-10 16:32:25