Info API¶
Get detailed information about users and groups. Used by, for example, chalmers.it to get user and group information to display on corresponding pages.
| Name | Value |
|---|---|
| API Key Type | INFO |
| Base URL | https://auth.chalmers.it/api/info/v1 |
| API Controller | InfoV1ApiController |
Table of Contents
Types¶
These are the types used in the Info API.
User with Groups¶
Example
{
"user": {
"cid": "janed",
"nick": "Dough",
"firstName": "Jane",
"lastName": "Doe",
"id": "2f63a363-af22-480d-be49-531c1831933c",
"acceptanceYear": 2025
},
"groups": [
{
"group": {
"id": "3cf94646-2412-4896-bba9-5d2410ac0c62",
"version": 18,
"name": "prit25",
"prettyName": "P.R.I.T. 25",
"superGroup": {
"id": "32da51ec-2854-4bc2-b19a-30dad5dcc501",
"version": 1,
"name": "prit",
"prettyName": "P.R.I.T.",
"type": "committee",
"svDescription": "PR och rustm\u00e4steri",
"enDescription": "PR and premises maintenance"
}
},
"post": {
"id": "0b960919-6dc0-4128-b772-c31840b7b8f7",
"version": 30,
"svName": "MaterialChef",
"enName": "MaterialChef",
"emailPrefix": "material",
"order": 11
}
}
]
}
User¶
Example
Group with Post¶
group:
id: GroupId
version: int
name: string
prettyName: string
superGroup: SuperGroup
post:
id: PostId
version: int
svName: string
enName: string
emailPrefix: string
order: int
Example
{
"group": {
"id": "7ec28eaa-7203-47fb-9c80-8b1678936be9",
"version": 18,
"name": "prit26",
"prettyName": "P.R.I.T. 26",
"superGroup": {
"id": "32da51ec-2854-4bc2-b19a-30dad5dcc501",
"name": "prit",
"prettyName": "P.R.I.T.",
"type": "committee",
"svDescription": "PR och rustm\u00e4steri",
"enDescription": "PR and premises maintenance"
}
},
"post": {
"id": "0b960919-6dc0-4128-b772-c31840b7b8f7",
"version": 30,
"svName": "MaterialChef",
"enName": "MaterialChef",
"emailPrefix": "material",
"order": 11
}
}
Super Group¶
id: SuperGroupId
version: int
name: string
prettyName: string
type: "alumni" | "committee" | "functionaries" | "society"
svDescription: string
enDescription: string
Example
Blob¶
Example
{
"type": "committee",
"superGroups": [
{
"superGroup": {
"id": "32da51ec-2854-4bc2-b19a-30dad5dcc501",
"name": "prit",
"prettyName": "P.R.I.T.",
"type": "committee",
"svDescription": "PR och rustm\u00e4steri",
"enDescription": "PR and premises maintenance"
},
"hasBanner": true,
"hasAvatar": true,
"members": [
{
"user": {
"id": "2f63a363-af22-480d-be49-531c1831933c",
"cid": "bloggsj",
"nick": "Bloggan",
"firstName": "Johnny",
"lastName": "Bloggs",
"acceptanceYear": 2025
},
"post": {
"id": "2a1a66a2-8e58-461c-96f1-9408a9c543f9",
"svName": "Medlem",
"enName": "Member",
"emailPrefix": ""
},
"unofficialPostName": "MatChef"
},
{
"user": {
"cid": "janed",
"nick": "Dough",
"firstName": "Jane",
"lastName": "Doe",
"id": "2f63a363-af22-480d-be49-531c1831933c",
"acceptanceYear": 2025
},
"post": {
"id": "0b960919-6dc0-4128-b772-c31840b7b8f7",
"svName": "MaterialChef",
"enName": "MaterialChef",
"emailPrefix": "material"
},
"unofficialPostName": ""
}
]
}
]
}
Blob Super Group¶
superGroup:
id: SuperGroupId
name: string
prettyName: string
type: "alumni" | "committee" | "functionaries" | "society"
svDescription: string
enDescription: string
hasBanner: boolean
hasAvatar: boolean
members: BlobMember[]
Example
{
"superGroup": {
"id": "32da51ec-2854-4bc2-b19a-30dad5dcc501",
"name": "prit",
"prettyName": "P.R.I.T.",
"type": "committee",
"svDescription": "PR och rustm\u00e4steri",
"enDescription": "PR and premises maintenance"
},
"hasBanner": true,
"hasAvatar": true,
"members": [
{
"user": {
"id": "2f63a363-af22-480d-be49-531c1831933c",
"cid": "bloggsj",
"nick": "Bloggan",
"firstName": "Johnny",
"lastName": "Bloggs",
"acceptanceYear": 2025
},
"post": {
"id": "2a1a66a2-8e58-461c-96f1-9408a9c543f9",
"svName": "Medlem",
"enName": "Member",
"emailPrefix": ""
},
"unofficialPostName": "MatChef"
},
{
"user": {
"cid": "janed",
"nick": "Dough",
"firstName": "Jane",
"lastName": "Doe",
"id": "2f63a363-af22-480d-be49-531c1831933c",
"acceptanceYear": 2025
},
"post": {
"id": "0b960919-6dc0-4128-b772-c31840b7b8f7",
"svName": "MaterialChef",
"enName": "MaterialChef",
"emailPrefix": "material"
},
"unofficialPostName": ""
}
]
}
Blob Member¶
user: User
post:
id: PostId
svName: string
enName: string
emailPrefix: string
unofficialPostName: string
Example
{
"user": {
"id": "2f63a363-af22-480d-be49-531c1831933c",
"cid": "bloggsj",
"nick": "Bloggan",
"firstName": "Johnny",
"lastName": "Bloggs",
"acceptanceYear": 2025
},
"post": {
"id": "2a1a66a2-8e58-461c-96f1-9408a9c543f9",
"svName": "Medlem",
"enName": "Member",
"emailPrefix": ""
},
"unofficialPostName": "MatChef"
}
Endpoints Reference¶
The Info API is currently hosted at https://auth.chalmers.it/api/info/v1 and all endpoints in this section are relative to this URL.
GET /users/{id}¶
Get information about a specific user.
Return type: User with Groups
Parameters¶
| Name | Type | Data Type | Description | |
|---|---|---|---|---|
| id | path | UserId | The user UUID |
Example¶
Click to show example request and response
Request¶
GET /users/2f63a363-af22-480d-be49-531c1831933c
Response¶
{
"user": {
"cid": "janed",
"nick": "Dough",
"firstName": "Jane",
"lastName": "Doe",
"id": "2f63a363-af22-480d-be49-531c1831933c",
"acceptanceYear": 2025
},
"groups": [
{
"group": {
"id": "3cf94646-2412-4896-bba9-5d2410ac0c62",
"name": "prit25",
"prettyName": "P.R.I.T. 25",
"superGroup": {
"id": "32da51ec-2854-4bc2-b19a-30dad5dcc501",
"version": 1,
"name": "prit",
"prettyName": "P.R.I.T.",
"type": "committee",
"svDescription": "PR och rustm\u00e4steri",
"enDescription": "PR and premises maintenance"
},
"version": 18
},
"post": {
"id": "0b960919-6dc0-4128-b772-c31840b7b8f7",
"version": 30,
"svName": "MaterialChef",
"enName": "MaterialChef",
"emailPrefix": "material",
"order": 11
}
}
]
}
GET /blob¶
Get the full detailed information about all super groups.
Return type: Blob list
Example¶
Click to show example request and response
Request¶
GET /blob
Response¶
[
{
"type": "alumni",
"superGroups": []
},
{
"type": "committee",
"superGroups": [
{
"superGroup": {
"id": "32da51ec-2854-4bc2-b19a-30dad5dcc501",
"name": "prit",
"prettyName": "P.R.I.T.",
"type": "committee",
"svDescription": "PR och rustm\u00e4steri",
"enDescription": "PR and premises maintenance"
},
"hasBanner": true,
"hasAvatar": true,
"members": [
{
"user": {
"id": "2f63a363-af22-480d-be49-531c1831933c",
"cid": "bloggsj",
"nick": "Bloggan",
"firstName": "Johnny",
"lastName": "Bloggs",
"acceptanceYear": 2025
},
"post": {
"id": "2a1a66a2-8e58-461c-96f1-9408a9c543f9",
"svName": "Medlem",
"enName": "Member",
"emailPrefix": ""
},
"unofficialPostName": "MatChef"
},
{
"user": {
"cid": "janed",
"nick": "Dough",
"firstName": "Jane",
"lastName": "Doe",
"id": "2f63a363-af22-480d-be49-531c1831933c",
"acceptanceYear": 2025
},
"post": {
"id": "0b960919-6dc0-4128-b772-c31840b7b8f7",
"svName": "MaterialChef",
"enName": "MaterialChef",
"emailPrefix": "material"
},
"unofficialPostName": ""
}
]
}
]
},
{
"type": "functionaries",
"superGroups": []
},
{
"type": "society",
"superGroups": []
}
]
Last modified on: 2026-04-10 16:32:25