soulfire.user_connect.UserServiceSync¶
- class soulfire.user_connect.UserServiceSync[source]¶
Bases:
ProtocolUserService provides user management functionality for the SoulFire system. All methods require authentication via JWT token in the request metadata. Most methods require specific global permissions (CREATE_USER, READ_USER, UPDATE_USER, DELETE_USER, INVALIDATE_SESSIONS, or GENERATE_API_TOKEN). Admin users automatically have all permissions. Note: The root user (ID: 00000000-0000-0000-0000-000000000000) cannot be modified or deleted. Note: Users cannot modify their own account through this service (use self-service endpoints instead).
- create_user(request: soulfire.user_pb2.UserCreateRequest, ctx: connectrpc.request.RequestContext[soulfire.user_pb2.UserCreateRequest, soulfire.user_pb2.UserCreateResponse], /) soulfire.user_pb2.UserCreateResponse[source]¶
Creates a new user account in the system. Requires the CREATE_USER global permission. Returns the UUID of the newly created user. Error cases:
INTERNAL: If username or email already exists, or validation fails
PERMISSION_DENIED: If caller lacks CREATE_USER permission
- delete_user(request: soulfire.user_pb2.UserDeleteRequest, ctx: connectrpc.request.RequestContext[soulfire.user_pb2.UserDeleteRequest, soulfire.user_pb2.UserDeleteResponse], /) soulfire.user_pb2.UserDeleteResponse[source]¶
Deletes an existing user from the system. Requires the DELETE_USER global permission. Cascades to delete all owned instances and audit logs. Also disconnects the user from any active log subscriptions. Error cases:
INTERNAL: If user not found, or attempting to delete self/root user
PERMISSION_DENIED: If caller lacks DELETE_USER permission
- list_users(request: soulfire.user_pb2.UserListRequest, ctx: connectrpc.request.RequestContext[soulfire.user_pb2.UserListRequest, soulfire.user_pb2.UserListResponse], /) soulfire.user_pb2.UserListResponse[source]¶
Lists all users in the system. Requires the READ_USER global permission. Returns complete information for all users including timestamps. Error cases:
INTERNAL: If database query fails
PERMISSION_DENIED: If caller lacks READ_USER permission
- get_user_info(request: soulfire.user_pb2.UserInfoRequest, ctx: connectrpc.request.RequestContext[soulfire.user_pb2.UserInfoRequest, soulfire.user_pb2.UserInfoResponse], /) soulfire.user_pb2.UserInfoResponse[source]¶
Retrieves detailed information about a specific user. Requires the READ_USER global permission. Error cases:
INTERNAL: If user not found
PERMISSION_DENIED: If caller lacks READ_USER permission
- invalidate_sessions(request: soulfire.user_pb2.InvalidateSessionsRequest, ctx: connectrpc.request.RequestContext[soulfire.user_pb2.InvalidateSessionsRequest, soulfire.user_pb2.InvalidateSessionsResponse], /) soulfire.user_pb2.InvalidateSessionsResponse[source]¶
Invalidates all active sessions for a user by updating their min_issued_at timestamp. Requires the INVALIDATE_SESSIONS global permission. After this call, all previously issued JWT tokens for the user become invalid, effectively logging them out of all devices. Error cases:
INTERNAL: If user not found, or attempting to invalidate self/root user sessions
PERMISSION_DENIED: If caller lacks INVALIDATE_SESSIONS permission
- update_user(request: soulfire.user_pb2.UpdateUserRequest, ctx: connectrpc.request.RequestContext[soulfire.user_pb2.UpdateUserRequest, soulfire.user_pb2.UpdateUserResponse], /) soulfire.user_pb2.UpdateUserResponse[source]¶
Updates an existing user’s profile information. Requires the UPDATE_USER global permission. All profile fields (username, email, role) are updated to the provided values. Error cases:
INTERNAL: If user not found, attempting to update self/root user, or validation fails
PERMISSION_DENIED: If caller lacks UPDATE_USER permission
- generate_user_api_token(request: soulfire.user_pb2.GenerateUserAPITokenRequest, ctx: connectrpc.request.RequestContext[soulfire.user_pb2.GenerateUserAPITokenRequest, soulfire.user_pb2.GenerateUserAPITokenResponse], /) soulfire.user_pb2.GenerateUserAPITokenResponse[source]¶
Generates a new API token (JWT) for a specific user. Requires the GENERATE_API_TOKEN global permission. The generated token has the “api” audience and does not expire. The token can be invalidated by calling InvalidateSessions for the user. Error cases:
INTERNAL: If user not found, or attempting to generate token for self/root user
PERMISSION_DENIED: If caller lacks GENERATE_API_TOKEN permission
- list_user_plugin_permission_grants(request: soulfire.user_pb2.ListUserPluginPermissionGrantsRequest, ctx: connectrpc.request.RequestContext[soulfire.user_pb2.ListUserPluginPermissionGrantsRequest, soulfire.user_pb2.ListUserPluginPermissionGrantsResponse], /) soulfire.user_pb2.ListUserPluginPermissionGrantsResponse[source]¶
Lists explicit dynamic plugin permission overrides for one user, including inactive grants retained for plugins that are not installed.
- set_user_plugin_permission_grant(request: soulfire.user_pb2.SetUserPluginPermissionGrantRequest, ctx: connectrpc.request.RequestContext[soulfire.user_pb2.SetUserPluginPermissionGrantRequest, soulfire.user_pb2.UserPluginPermissionGrant], /) soulfire.user_pb2.UserPluginPermissionGrant[source]¶
Creates or replaces one explicit plugin permission override.
- delete_user_plugin_permission_grant(request: soulfire.user_pb2.DeleteUserPluginPermissionGrantRequest, ctx: connectrpc.request.RequestContext[soulfire.user_pb2.DeleteUserPluginPermissionGrantRequest, soulfire.user_pb2.DeleteUserPluginPermissionGrantResponse], /) soulfire.user_pb2.DeleteUserPluginPermissionGrantResponse[source]¶
Removes one explicit override so the plugin permission’s default grant policy applies again.