Tiimijäsenten API
Ylläpitäjä: Aether365-tiimi Kohderyhmä: Kehittäjät Laajuus: Tiimijäsenten API-päätepisteet - käyttäjien käyttöoikeuksien hallinta
Valtuutus
Tiimijäsenten päätepisteet käyttävät roolipohjaista käyttöoikeuksien hallintaa:
| Päätepiste | Sallitut roolit |
|---|---|
| Jäsenten listaus | Owner, Admin, Member |
| Jäsenen kutsuminen | Owner, Admin |
| Jäsenen roolin muuttaminen | Owner |
| Jäsenen poistaminen | Owner |
Listaa tiimijäsenet
Palauttaa kaikki todennetun vuokralaistilin jäsenet.
GET /tenants/me/membersEsimerkkipyyntö
bash
curl https://api.aether365.io/tenants/me/members \
-H "Authorization: Bearer <token>"Esimerkkivastaus
json
{
"success": true,
"data": [
{
"id": "mem_abc123",
"email": "alice@example.com",
"status": "active",
"role": "owner",
"invitedAt": "2026-01-15T10:00:00Z",
"joinedAt": "2026-01-15T10:30:00Z"
},
{
"id": "mem_def456",
"email": "bob@example.com",
"status": "active",
"role": "member",
"invitedAt": "2026-02-01T09:00:00Z",
"joinedAt": "2026-02-01T11:00:00Z"
},
{
"id": "mem_ghi789",
"email": "carol@example.com",
"status": "pending",
"role": "member",
"invitedAt": "2026-04-10T08:00:00Z",
"joinedAt": null
}
]
}Vastauksen kentät
| Kenttä | Tyyppi | Kuvaus |
|---|---|---|
id | string | Jäsenen tunniste |
email | string | Jäsenen sähköpostiosoite |
status | string | active tai pending |
role | string | owner, admin tai member |
invitedAt | string | ISO 8601 -aikaleima kutsusta |
joinedAt | string tai null | ISO 8601 -aikaleima kutsun hyväksymisestä |
Kutsu tiimijäsen
Lähettää kutsusähköpostin uudelle tiimijäsenelle.
POST /tenants/me/members/invitePyynnön runko
json
{
"email": "newmember@example.com",
"role": "member"
}| Kenttä | Tyyppi | Pakollinen | Oletus | Kuvaus |
|---|---|---|---|---|
email | string | Kyllä | - | Kutsuttava sähköpostiosoite |
role | string | Ei | "member" | "member" tai "admin" |
Esimerkkipyyntö
bash
curl -X POST https://api.aether365.io/tenants/me/members/invite \
-H "Authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d '{"email": "newmember@example.com", "role": "member"}'Esimerkkivastaus
json
{
"success": true,
"data": {
"id": "mem_xyz999",
"email": "newmember@example.com",
"status": "pending",
"role": "member",
"invitedAt": "2026-04-12T10:00:00Z",
"joinedAt": null
}
}Virheet
| Koodi | HTTP | Kuvaus |
|---|---|---|
MEMBER_LIMIT_REACHED | 429 | Suunnitelman jäsenraja saavutettu |
MEMBER_ALREADY_EXISTS | 409 | Tämä sähköposti on jo jäsen tai sillä on odottava kutsu |
VALIDATION_ERROR | 400 | Virheellinen sähköpostiosoite |
Muuta jäsenen rooli
Muuttaa olemassa olevan tiimijäsenen roolin.
PATCH /tenants/me/members/{memberId}WARNING
Vain tilin omistaja voi muuttaa rooleja. Ylläpitäjät eivät voi muuttaa rooleja.
Pyynnön runko
json
{
"role": "admin"
}| Kenttä | Tyyppi | Pakollinen | Kuvaus |
|---|---|---|---|
role | string | Kyllä | Uusi rooli: "member" tai "admin" |
Esimerkkipyyntö
bash
curl -X PATCH https://api.aether365.io/tenants/me/members/mem_def456 \
-H "Authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d '{"role": "admin"}'Esimerkkivastaus
json
{
"success": true,
"data": {
"id": "mem_def456",
"email": "bob@example.com",
"status": "active",
"role": "admin",
"invitedAt": "2026-02-01T09:00:00Z",
"joinedAt": "2026-02-01T11:00:00Z"
}
}Poista tiimijäsen
Poistaa jäsenen tilista. Tämä poistaa käyttöoikeuden välittömästi.
DELETE /tenants/me/members/{memberId}WARNING
Tilin omistajaa ei voi poistaa. Omistajuuden siirtämiseksi ota yhteyttä tukeen.
Esimerkkipyyntö
bash
curl -X DELETE https://api.aether365.io/tenants/me/members/mem_def456 \
-H "Authorization: Bearer <token>"Esimerkkivastaus
json
{
"success": true,
"data": null
}