MemberService
Manages organization members — invitations, profiles, role assignments, and user settings.
Methods
Section titled “Methods”| Method | Description |
|---|---|
InviteUser | Invite a user to the organization |
GetUser | Get a user by ID |
ListUsers | List organization members |
UpdateUserRole | Change a user’s role |
DeactivateUser | Deactivate a user |
UpdateUserProfile | Update a user’s profile |
GetUserSettings | Get user settings |
UpdateUserSettings | Update user settings |
InviteUser
Section titled “InviteUser”Invite a new user to the organization. Sends an email invitation.
Authorization: Requires MANAGE_MEMBERS permission
Request: InviteUserRequest
Section titled “Request: InviteUserRequest”| Field | Type | Description |
|---|---|---|
email | string | Email address of the user to invite. |
role_id | string | Role to assign. |
Response: InviteUserResponse
Section titled “Response: InviteUserResponse”| Field | Type | Description |
|---|---|---|
user | User | The invited user. |
GetUser
Section titled “GetUser”Authorization: Authenticated user (own profile) or VIEW_MEMBERS permission
Request: GetUserRequest
Section titled “Request: GetUserRequest”| Field | Type | Description |
|---|---|---|
id | string | User ID. |
Response: GetUserResponse
Section titled “Response: GetUserResponse”| Field | Type | Description |
|---|---|---|
user | User | The user. |
ListUsers
Section titled “ListUsers”Authorization: Requires VIEW_MEMBERS permission
Request: ListUsersRequest
Section titled “Request: ListUsersRequest”| Field | Type | Description |
|---|---|---|
pagination | Pagination | Pagination parameters. |
Response: ListUsersResponse
Section titled “Response: ListUsersResponse”| Field | Type | Description |
|---|---|---|
users | User[] | List of users. |
pagination | PaginationMeta | Pagination metadata. |
UpdateUserRole
Section titled “UpdateUserRole”Authorization: Requires MANAGE_MEMBERS permission
Request: UpdateUserRoleRequest
Section titled “Request: UpdateUserRoleRequest”| Field | Type | Description |
|---|---|---|
user_id | string | User ID. |
role_id | string | New role ID. |
Response: UpdateUserRoleResponse
Section titled “Response: UpdateUserRoleResponse”| Field | Type | Description |
|---|---|---|
user | User | The updated user. |
DeactivateUser
Section titled “DeactivateUser”Authorization: Requires MANAGE_MEMBERS permission
Request: DeactivateUserRequest
Section titled “Request: DeactivateUserRequest”| Field | Type | Description |
|---|---|---|
user_id | string | User ID to deactivate. |
Response: DeactivateUserResponse
Section titled “Response: DeactivateUserResponse”Empty response on success.
UpdateUserProfile
Section titled “UpdateUserProfile”Update the authenticated user’s profile.
Authorization: Authenticated user (own profile only)
Request: UpdateUserProfileRequest
Section titled “Request: UpdateUserProfileRequest”| Field | Type | Description |
|---|---|---|
display_name | string | Display name. Max 200 characters. |
avatar_url | string | Avatar URL. Max 2048 characters. |
custom_attributes | map<string, string> | Custom profile attributes. |
Response: UpdateUserProfileResponse
Section titled “Response: UpdateUserProfileResponse”| Field | Type | Description |
|---|---|---|
profile | UserProfile | The updated profile. |
GetUserSettings
Section titled “GetUserSettings”Authorization: Authenticated user (own settings only)
Request: GetUserSettingsRequest
Section titled “Request: GetUserSettingsRequest”Empty request.
Response: GetUserSettingsResponse
Section titled “Response: GetUserSettingsResponse”| Field | Type | Description |
|---|---|---|
settings | UserSettings | The user’s settings. |
UpdateUserSettings
Section titled “UpdateUserSettings”Authorization: Authenticated user (own settings only)
Request: UpdateUserSettingsRequest
Section titled “Request: UpdateUserSettingsRequest”| Field | Type | Description |
|---|---|---|
notifications_enabled | bool | Whether push notifications are enabled. |
theme_preference | ThemePreference | Preferred theme (SYSTEM, LIGHT, DARK). |
Response: UpdateUserSettingsResponse
Section titled “Response: UpdateUserSettingsResponse”| Field | Type | Description |
|---|---|---|
settings | UserSettings | The updated settings. |