API organizacji
Odczyt metadanych organizacji powiązanej z danymi uwierzytelniającymi. Tylko do odczytu w publicznym API — ustawienia organizacji (retencja, zgoda na SMS, KYB) są zarządzane z panelu administracyjnego w aplikacji, gdzie łańcuch audytu rejestruje, kto, co i kiedy zmienił.
Pobierz organizację
GET /api/v1/public/org — zakres org:read
curl https://app.nexbasira.com/api/v1/public/org \
-H "Authorization: Bearer nb_sec_..." {
"id": "00000000-0000-0000-0000-000000000000",
"name": "Acme Insurance",
"country": "FR",
"settings_jsonb": {
"default_locale": "fr",
"auto_record_sessions": false
},
"retention_days": 2555,
"sms_enabled": true,
"created_at": "2024-09-01T08:00:00Z"
} | Pole | Typ | Uwagi |
|---|---|---|
id | UUID | Niezmienny przez cały okres istnienia danych uwierzytelniających. |
name | string | Nazwa wyświetlana. Widoczna w e-mailach z zaproszeniami oraz w nagłówku raportu PDF. |
country | ISO 3166-1 alpha-2 | Określa domyślną lokalizację językową oraz jurysdykcję KYB. |
settings_jsonb | object | Dowolne preferencje na poziomie organizacji (domyślna lokalizacja językowa, przełącznik automatycznego nagrywania itp.). Schemat jest zgodny w przód — nieznane klucze należy traktować jako informacyjne. |
retention_days | int | null | Jak długo bajty materiału dowodowego są przechowywane w object storage, zanim reguły cyklu życia je usuną. null = wartość domyślna platformy (7 lat dla wdrożeń zgodnych z eIDAS). |
sms_enabled | bool | Czy dostarczanie zaproszeń przez SMS jest włączone. Domyślnie false; włączane w karcie SMS panelu administracyjnego. |
created_at | ISO 8601 | Znacznik czasu utworzenia organizacji. |
Częste błędy
| Status | Kod | Kiedy |
|---|---|---|
| 403 | permission_denied | Dane uwierzytelniające nie mają uprawnienia org:read. |
Uwagi
- Jedna organizacja na dane uwierzytelniające. Każde dane uwierzytelniające publicznego API są ograniczone do dokładnie jednej organizacji; nie przekazuje się
org_id— dane uwierzytelniające rozwiązują ją po stronie serwera. - Brak możliwości zapisu. Zmiany ustawień organizacji przechodzą przez interfejs administracyjny, aby tożsamość operatora oraz powód mogły podlegać audytowi. Publiczne API pozostaje tutaj celowo tylko do odczytu.
- White-label. W celu dostosowania logo i kolorów zobacz Branding API — to jest obszar z możliwością zapisu.