Loomion palvelimen API:n dokumentaatio
/api/b3 on tarkoitettu palvelintason toimintoihin. Käytä /api/b2-rajapintaa käyttäjäkohtaisiin toimintoihin, jotka suoritetaan Loomion käyttäjätilillä.
Todennus
Aseta B3_API_KEY-muuttujan arvoksi yli 16 merkin pituinen salainen avain.
Lähetä avain bearer-tokenina:
curl -H 'Authorization: Bearer YOUR_SERVER_API_KEY' https://www.loomio.com/api/b3/users
Lähetä tunnistetiedot vain Authorization-otsakkeessa. Kyselymerkkijonoissa tai pyyntöjen rungoissa lähetetyt API-avaimet hylätään.
Käyttäjäobjekti
Käyttäjätietoja sisältävien vastausten rakenne on seuraava:
{
"id": 123,
"name": "Ada Lovelace",
"username": "ada",
"email": "ada@example.org",
"active": true,
"deactivated_at": null,
"identities": [
{
"id": 456,
"identity_type": "oauth",
"uid": "external-123",
"email": "ada@example.org",
"name": "Ada Lovelace"
}
]
}
Listaa käyttäjät
Listaa kaikki Loomio-asennuksen käyttäjätilit.
GET /api/b3/users
Esimerkki
curl -H 'Authorization: Bearer YOUR_SERVER_API_KEY' https://www.loomio.com/api/b3/users
Palauttaa:
{
"users": []
}
Näytä käyttäjä
Etsi käyttäjä Loomion käyttäjä-ID:n tai ulkoisen identiteetin perusteella.
GET /api/b3/users/:id
GET /api/b3/users/identity/:identity_type/:uid
Esimerkkejä
Loomion käyttäjä-ID:n perusteella:
curl -H 'Authorization: Bearer YOUR_SERVER_API_KEY' https://www.loomio.com/api/b3/users/123
Ulkoisen identiteetin perusteella:
curl -H 'Authorization: Bearer YOUR_SERVER_API_KEY' https://www.loomio.com/api/b3/users/identity/oauth/external-123
Palauttaa:
{
"user": {}
}
Päivitä käyttäjä
Päivitä Loomion käyttäjä-ID:n tai ulkoisen identiteetin perusteella löydetyn käyttäjän profiilikentät.
PATCH /api/b3/users/:id
PATCH /api/b3/users/identity/:identity_type/:uid
Parametrit
| Kenttä | Kuvaus |
|---|---|
name |
Näyttönimi |
username |
Loomion käyttäjänimi |
email |
Sähköpostiosoite |
Esimerkkejä
Loomion käyttäjä-ID:n perusteella:
curl -X PATCH \
-H 'Authorization: Bearer YOUR_SERVER_API_KEY' \
-H 'Content-Type: application/json' \
-d '{"user":{"name":"Ada Lovelace","username":"ada","email":"ada@example.org"}}' \
https://www.loomio.com/api/b3/users/123
Ulkoisen identiteetin perusteella:
curl -X PATCH \
-H 'Authorization: Bearer YOUR_SERVER_API_KEY' \
-H 'Content-Type: application/json' \
-d '{"user":{"name":"Ada Lovelace","username":"ada","email":"ada@example.org"}}' \
https://www.loomio.com/api/b3/users/identity/oauth/external-123
Palauttaa päivitetyn käyttäjän:
{
"user": {}
}
Poista käyttäjätili käytöstä
Poista käytöstä käyttäjätili, joka on löydetty Loomion käyttäjä-ID:n tai ulkoisen identiteetin perusteella.
POST /api/b3/users/:id/deactivate
POST /api/b3/users/identity/:identity_type/:uid/deactivate
Esimerkkejä
Loomion käyttäjä-ID:n perusteella:
curl -X POST -H 'Authorization: Bearer YOUR_SERVER_API_KEY' https://www.loomio.com/api/b3/users/123/deactivate
Ulkoisen identiteetin perusteella:
curl -X POST -H 'Authorization: Bearer YOUR_SERVER_API_KEY' https://www.loomio.com/api/b3/users/identity/oauth/external-123/deactivate
Palauttaa:
{
"success": true,
"user": {}
}
Aktivoi käyttäjä uudelleen
Aktivoi käytöstä poistettu käyttäjätili uudelleen Loomion käyttäjätunnisteen tai ulkoisen identiteetin perusteella.
POST /api/b3/users/:id/reactivate
POST /api/b3/users/identity/:identity_type/:uid/reactivate
Esimerkkejä
Loomion käyttäjätunnisteen perusteella:
curl -X POST -H 'Authorization: Bearer YOUR_SERVER_API_KEY' https://www.loomio.com/api/b3/users/123/reactivate
Ulkoisen identiteetin perusteella:
curl -X POST -H 'Authorization: Bearer YOUR_SERVER_API_KEY' https://www.loomio.com/api/b3/users/identity/oauth/external-123/reactivate
Palauttaa:
{
"success": true,
"user": {}
}
Poista käyttäjän tunnistetiedot
Tunnistetietojen poistaminen säilyttää käyttäjän kommentit ja muun käyttäjän luoman sisällön hänen ryhmissään, mutta poistaa tiedossa olevat henkilön tunnistamiseen käytettävät tiedot, kuten nimen, esittelyn, profiilikuvan, sähköpostiosoitteen, kirjautumistiedot, identiteetit ja aktiiviset istunnot.
Tämä on suositeltu tapa poistaa käyttäjä Loomiosta.
POST /api/b3/users/:id/redact
POST /api/b3/users/identity/:identity_type/:uid/redact
Esimerkkejä
Loomion käyttäjätunnisteen perusteella:
curl -X POST -H 'Authorization: Bearer YOUR_SERVER_API_KEY' https://www.loomio.com/api/b3/users/123/redact
Ulkoisen identiteetin perusteella:
curl -X POST -H 'Authorization: Bearer YOUR_SERVER_API_KEY' https://www.loomio.com/api/b3/users/identity/oauth/external-123/redact
Palauttaa:
{
"success": true
}
Poista käyttäjä
Poistaminen poistaa käyttäjän ja hänen luomansa tietueet. Kommentit poistetaan ketjuista ja äänet kyselyistä. Myös käyttäjän luomat ryhmät, keskustelut, kyselyt ja muut tietueet voivat poistua tietokannan tietueiden välisten suhteiden kautta.
Tämä poistaa laajasti tietoja. Käyttäjän tunnistetietojen poistaminen on vahvasti suositeltu vaihtoehto.
DELETE /api/b3/users/:id
DELETE /api/b3/users/identity/:identity_type/:uid
Esimerkkejä
Loomion käyttäjätunnisteen perusteella:
curl -X DELETE -H 'Authorization: Bearer YOUR_SERVER_API_KEY' https://www.loomio.com/api/b3/users/123
Ulkoisen identiteetin perusteella:
curl -X DELETE -H 'Authorization: Bearer YOUR_SERVER_API_KEY' https://www.loomio.com/api/b3/users/identity/oauth/external-123
Palauttaa:
{
"success": true
}
SSO-profiilin synkronointiasetukset
Käytä näitä asetuksia, kun toinen järjestelmä hallinnoi Loomion profiilikenttiä.
LOOMIO_DISABLE_EDIT_USER_PROFILE=1
# LOOMIO_SSO_UPDATE_USER_PROFILE_ON_LOGIN=1
LOOMIO_DISABLE_EDIT_USER_PROFILE=1 estää käyttäjiä muokkaamasta itse seuraavia kenttiä:
| Kenttä | Huomautukset |
|---|---|
name |
Ulkoisen synkronoinnin hallinnoima |
username |
Ulkoisen synkronoinnin hallinnoima |
email |
Ulkoisen synkronoinnin hallinnoima |
avatar_kind / uploaded_avatar |
Ulkoisen synkronoinnin hallinnoima |
Käyttäjät voivat edelleen muokata Loomion paikallisia kenttiä, kuten short_bio ja location.
LOOMIO_SSO_UPDATE_USER_PROFILE_ON_LOGIN=1 päivittää kentät name ja email SSO-kirjautumistiedoista. Jätä asetus kommentoiduksi tai määrittämättä, kun vain ulkoisen synkronointiskriptin on tarkoitus päivittää näitä kenttiä.
LOOMIO_SSO_FORCE_USER_ATTRS toimii edelleen olemassa olevissa asennuksissa. Se sekä estää käyttäjiä muokkaamasta kenttiä että päivittää kentät name ja email SSO-kirjautumisen yhteydessä.