Pełna dokumentacja API do zarządzania użytkownikami, zaproszeniami, rolami i uprawnieniami w projektach i firmach Blue
Przegląd
API Zarządzania Użytkownikami zapewnia kompleksowe narzędzia do zarządzania członkami zespołu, kontrolowania uprawnień dostępu oraz organizowania siły roboczej w projektach i firmach Blue. Niezależnie od tego, czy dodajesz nowych członków zespołu, zarządzasz istniejącymi użytkownikami, czy definiujesz niestandardowe struktury uprawnień, te API obsługują wszystkie aspekty zarządzania cyklem życia użytkownika.
Zarządzanie użytkownikami w Blue działa na dwóch poziomach:
- Poziom projektu: Zarządzaj użytkownikami w ramach konkretnych projektów z uprawnieniami specyficznymi dla projektu
- Poziom firmy: Zarządzaj użytkownikami w całej organizacji z dostępem na poziomie firmy
Dostępne Operacje
Podstawowe Zarządzanie Użytkownikami
Operacja | Opis | Link |
---|---|---|
Invite User | Wysyłaj zaproszenia do nowych użytkowników z określonymi poziomami dostępu | View Details → |
List Users | Zapytaj i filtruj użytkowników w projektach lub firmach | View Details → |
Remove User | Usuń użytkowników z projektów lub firm | View Details → |
Zarządzanie Rolami i Uprawnieniami
Operacja | Opis | Link |
---|---|---|
Custom Roles | Twórz i zarządzaj niestandardowymi rolami z szczegółowymi uprawnieniami | View Details → |
Poziomy Dostępu
Blue zapewnia hierarchiczny system uprawnień z predefiniowanymi poziomami dostępu:
Standardowe Poziomy Dostępu
Poziom | Opis | Możliwości |
---|---|---|
OWNER | Pełna kontrola nad projektem/firmą | All permissions, can transfer ownership |
ADMIN | Dostęp administracyjny | User management, settings, billing |
MEMBER | Standardowy członek zespołu | Full project functionality, limited admin access |
CLIENT | Dostęp klienta zewnętrznego | Limited project visibility, focused on deliverables |
COMMENT_ONLY | Tylko dostęp do komentarzy | Może przeglądać i komentować, nie może edytować |
VIEW_ONLY | Tylko dostęp do odczytu | Can view content only |
Hierarchia Uprawnień
Użytkownicy mogą zapraszać lub zarządzać użytkownikami na swoim poziomie lub poniżej:
- WŁAŚCICIELE mogą zarządzać wszystkimi poziomami dostępu
- ADMINI mogą zarządzać ADMIN, CZŁONKAMI, KLIENTAMI, TYLKO_KOMENTARZAMI, TYLKO_ODCZYTEM
- CZŁONKOWIE mogą zarządzać CZŁONKAMI, KLIENTAMI, TYLKO_KOMENTARZAMI, TYLKO_ODCZYTEM
- KLIENCI mogą zarządzać tylko innymi KLIENTAMI
Kluczowe Koncepcje
Zaproszenia Użytkowników
- Na podstawie e-maila: Użytkownicy są zapraszani za pośrednictwem adresu e-mail
- Przydzielanie ról: Ustaw poziom dostępu i opcjonalną niestandardową rolę podczas zaproszenia
- Wieloprojektowe: Jedno zaproszenie może przyznać dostęp do wielu projektów
- Wygaszenie: Zaproszenia wygasają po 7 dniach
- Automatyczne powiadomienia: Blue automatycznie wysyła zaproszenia e-mail
Dostęp do Projektu vs Firmy
- Zaproszenie do projektu: Przyznaje dostęp tylko do konkretnego projektu
- Zaproszenie do firmy: Przyznaje dostęp na poziomie firmy, opcjonalnie obejmując konkretne projekty
- Właściciele firmy: Automatycznie uzyskują dostęp ADMIN do wszystkich projektów firmy
- Ograniczenia zakresu: Nie można łączyć parametrów zaproszenia do projektu i firmy
Niestandardowe Role
- Szczegółowe uprawnienia: Definiuj konkretne możliwości wykraczające poza standardowe poziomy dostępu
- Specyficzne dla projektu: Niestandardowe role są ograniczone do poszczególnych projektów
- Kontrola na poziomie pól: Kontroluj dostęp do konkretnych niestandardowych pól
- Ograniczenia działań: Ogranicz konkretne działania (tworzenie, edytowanie, usuwanie itp.)
Powszechne Wzorce
Zapraszanie Nowego Członka Zespołu
mutation InviteTeamMember {
inviteUser(input: {
email: "john.doe@company.com"
projectId: "web-redesign"
accessLevel: MEMBER
})
}
Tworzenie Zaproszenia na Poziomie Firmy
mutation InviteToCompany {
inviteUser(input: {
email: "manager@company.com"
companyId: "company_123"
projectIds: ["project_1", "project_2", "project_3"]
accessLevel: ADMIN
})
}
Lista Użytkowników Projektu
query ProjectUsers {
projectUsers(projectId: "web-redesign") {
id
user {
name
email
avatar
}
accessLevel
role {
name
permissions
}
invitedAt
joinedAt
}
}
Usuwanie Użytkownika
mutation RemoveProjectUser {
removeUser(input: {
userId: "user_456"
projectId: "web-redesign"
})
}
Tworzenie Niestandardowej Roli
mutation CreateCustomRole {
createProjectUserRole(input: {
projectId: "web-redesign"
name: "Content Reviewer"
permissions: {
canCreateRecords: false
canEditOwnRecords: true
canEditAllRecords: false
canDeleteRecords: false
canManageUsers: false
canViewReports: true
}
}) {
id
name
permissions
}
}
Zarządzanie Uprawnieniami
Standardowa Macierz Uprawnień
Działanie | WŁAŚCICIEL | ADMIN | CZŁONEK | KLIENT | TYLKO_KOMENTARZE | TYLKO_ODCZYT |
---|---|---|---|---|---|---|
Invite Users | ✅ Wszystkie poziomy | ✅ ADMIN i niższe | ✅ CZŁONEK i niższe | ✅ Tylko KLIENT | ❌ Nie | ❌ Nie |
Remove Users | ✅ Wszyscy użytkownicy | ✅ ADMIN i niższe | ✅ CZŁONEK i niższe | ✅ Tylko KLIENT | ❌ Nie | ❌ Nie |
Modify Project Settings | ✅ Tak | ✅ Tak | ❌ Nie | ❌ Nie | ❌ Nie | ❌ Nie |
Create Records | ✅ Tak | ✅ Tak | ✅ Tak | ✅ Ograniczone | ❌ Nie | ❌ Nie |
Edit All Records | ✅ Tak | ✅ Tak | ✅ Tak | ❌ Nie | ❌ Nie | ❌ Nie |
Delete Records | ✅ Tak | ✅ Tak | ✅ Tak | ❌ Nie | ❌ Nie | ❌ Nie |
View Reports | ✅ Tak | ✅ Tak | ✅ Tak | ✅ Ograniczone | ❌ Nie | ❌ Nie |
Możliwości Niestandardowej Roli
- Uprawnienia na poziomie pól: Kontroluj dostęp do konkretnych niestandardowych pól
- Reguły specyficzne dla działań: Zezwól/odmów na konkretne operacje (tworzenie, edytowanie, usuwanie)
- Ograniczenia widoku: Ogranicz, które rekordy użytkownicy mogą zobaczyć
- Przełączniki funkcji: Włącz/wyłącz konkretne funkcje dla roli
Najlepsze Praktyki
Wprowadzenie Użytkownika
- Zacznij od standardowych ról - Użyj predefiniowanych poziomów dostępu dla większości użytkowników
- Postępujące uprawnienia - Rozpocznij od ograniczonego dostępu, rozszerzaj w miarę potrzeb
- Jasna komunikacja - Dołącz kontekst podczas wysyłania zaproszeń
- Regularne przeglądy - Audytuj dostęp użytkowników okresowo
Rozważania Bezpieczeństwa
- Zasada najmniejszych uprawnień - Przyznawaj minimalne niezbędne uprawnienia
- Regularne audyty dostępu - Przeglądaj uprawnienia użytkowników co kwartał
- Proces offboardingu - Natychmiast usuń dostęp, gdy użytkownicy opuszczają firmę
- Dokumentacja niestandardowych ról - Dokumentuj cele i ograniczenia niestandardowych ról
Organizacja Zespołu
- Spójne nazewnictwo - Używaj jasnych, opisowych nazw ról
- Konsolidacja ról - Unikaj tworzenia zbyt wielu podobnych niestandardowych ról
- Struktura firmy - Dostosuj uprawnienia do hierarchii organizacyjnej
- Dziedziczenie projektów - Rozważ, jak role firmy wpływają na dostęp do projektów
Obsługa Błędów
Typowe błędy podczas zarządzania użytkownikami:
Kod błędu | Opis | Rozwiązanie |
---|---|---|
USER_ALREADY_IN_THE_PROJECT |
Użytkownik ma już dostęp do projektu | Check current user list before inviting |
UNAUTHORIZED |
Niewystarczające uprawnienia do wykonania akcji | Verify your access level and permissions |
PROJECT_NOT_FOUND |
Projekt nie istnieje lub brak dostępu | Confirm project ID and access rights |
INVITATION_LIMIT |
Osiągnięto limit zaproszeń dla poziomu rozliczeniowego | Upgrade plan or remove inactive users |
ADD_SELF |
Nie można zaprosić samego siebie | Użyj innego e-maila lub poproś innego administratora o zaproszenie |
COMPANY_BANNED |
Konto firmy jest zawieszone | Contact support to resolve account status |
Limity Częstotliwości
Operacje zarządzania użytkownikami mają następujące limity częstotliwości:
- Zaproszenia: 100 na godzinę na firmę
- Zapytania o użytkowników: 1000 na godzinę na użytkownika
- Modyfikacje ról: 50 na godzinę na projekt
Powiązane Zasoby
- API Projektów - Zarządzanie projektami, które zawierają użytkowników
- API Rekordów - Zrozumienie, jak uprawnienia użytkowników wpływają na dostęp do rekordów
- API Automatyzacji - Automatyzacja procesów zarządzania użytkownikami
- API Niestandardowych Pól - Zarządzanie uprawnieniami na poziomie pól dla niestandardowych ról