Skip to content

Meeskonnaliikmete API

Autoriseerimine

Meeskonnaliikmete lõpp-punktid kasutavad rollipõhist juurdepääsukontrolli:

Lõpp-punktLubatud rollid
Liikmete loeteluOwner, Admin, Member
Liikme kutsumineOwner, Admin
Liikme rolli muutmineOwner
Liikme eemaldamineOwner

Meeskonnaliikmete loetelu

Tagastab kõik autenditud halduskeskkonna konto liikmed.

GET /tenants/me/members

Näidispäring

bash
curl https://api.aether365.io/tenants/me/members \
  -H "Authorization: Bearer <token>"

Näidisvastus

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
    }
  ]
}

Vastuse väljad

VäliTüüpKirjeldus
idstringLiikme identifikaator
emailstringLiikme e-posti aadress
statusstringactive või pending
rolestringowner, admin või member
invitedAtstringKutse ISO 8601 ajatempel
joinedAtstring või nullKutse vastuvõtmise ISO 8601 ajatempel

Meeskonnaliikme kutsumine

Saadab uuele meeskonnaliikmele kutsemeili.

POST /tenants/me/members/invite

Päringu keha

json
{
  "email": "newmember@example.com",
  "role": "member"
}
VäliTüüpNõutavVaikeväärtusKirjeldus
emailstringJah-Kutse e-posti aadress
rolestringEi"member""member" või "admin"

Näidispäring

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"}'

Näidisvastus

json
{
  "success": true,
  "data": {
    "id": "mem_xyz999",
    "email": "newmember@example.com",
    "status": "pending",
    "role": "member",
    "invitedAt": "2026-04-12T10:00:00Z",
    "joinedAt": null
  }
}

Vead

KoodHTTPKirjeldus
MEMBER_LIMIT_REACHED429Plaani liikmete limiit on täis
MEMBER_ALREADY_EXISTS409See e-posti aadress on juba liige või on ootel kutse
VALIDATION_ERROR400Vigane e-posti aadress

Liikme rolli muutmine

Muudab olemasoleva meeskonnaliikme rolli.

PATCH /tenants/me/members/{memberId}

WARNING

Ainult konto omanik saab rolle muuta. Administraatoritel puudub rollide muutmise õigus.

Päringu keha

json
{
  "role": "admin"
}
VäliTüüpNõutavKirjeldus
rolestringJahUus roll: "member" või "admin"

Näidispäring

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"}'

Näidisvastus

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"
  }
}

Meeskonnaliikme eemaldamine

Eemaldab liikme kontolt. Ta kaotab kohe juurdepääsu.

DELETE /tenants/me/members/{memberId}

WARNING

Konto omanikku ei saa eemaldada. Omandiõiguse üleandmiseks võtke ühendust klienditoega.

Näidispäring

bash
curl -X DELETE https://api.aether365.io/tenants/me/members/mem_def456 \
  -H "Authorization: Bearer <token>"

Näidisvastus

json
{
  "success": true,
  "data": null
}
Kas sellest lehest oli abi?