@@ -239,6 +239,10 @@ object that can be used to interact with the Management API.
239239 :toctree: generated/
240240
241241 manage_workspaces
242+ manage_teams
243+ manage_users
244+ manage_audit_logs
245+ manage_private_connections
242246
243247
244248WorkspaceManager
@@ -430,6 +434,198 @@ FilesObject
430434 FilesObject.rmdir
431435
432436
437+ TeamsManager
438+ ............
439+
440+ TeamsManager objects are returned by the :func: `manage_teams ` function.
441+ They allow you to create, retrieve, and manage teams in your organization.
442+
443+ .. currentmodule :: singlestoredb.management.teams
444+
445+ .. autosummary ::
446+ :toctree: generated/
447+
448+ TeamsManager
449+ TeamsManager.create_team
450+ TeamsManager.get_team
451+ TeamsManager.list_teams
452+ TeamsManager.teams
453+ TeamsManager.delete_team
454+ TeamsManager.update_team
455+ TeamsManager.get_team_identity_roles
456+
457+
458+ Team
459+ ....
460+
461+ Team objects are retrieved from :meth: `TeamsManager.get_team ` or by
462+ retrieving an element from :attr: `TeamsManager.teams `.
463+
464+ .. autosummary ::
465+ :toctree: generated/
466+
467+ Team
468+ Team.update
469+ Team.delete
470+ Team.refresh
471+ Team.identity_roles
472+
473+
474+ UsersManager
475+ ............
476+
477+ UsersManager objects are returned by the :func: `manage_users ` function.
478+ They allow you to retrieve and manage users in your organization.
479+
480+ .. currentmodule :: singlestoredb.management.users
481+
482+ .. autosummary ::
483+ :toctree: generated/
484+
485+ UsersManager
486+ UsersManager.get_user
487+ UsersManager.get_user_identity_roles
488+
489+
490+ User
491+ ....
492+
493+ User objects are retrieved from :meth: `UsersManager.get_user `.
494+
495+ .. autosummary ::
496+ :toctree: generated/
497+
498+ User
499+ User.identity_roles
500+
501+
502+ AuditLogsManager
503+ ................
504+
505+ AuditLogsManager objects are returned by the :func: `manage_audit_logs ` function.
506+ They allow you to retrieve and analyze audit logs for your organization.
507+
508+ .. currentmodule :: singlestoredb.management.audit_logs
509+
510+ .. autosummary ::
511+ :toctree: generated/
512+
513+ AuditLogsManager
514+ AuditLogsManager.list_audit_logs
515+ AuditLogsManager.audit_logs
516+ AuditLogsManager.get_audit_logs_for_user
517+ AuditLogsManager.get_audit_logs_for_resource
518+ AuditLogsManager.get_failed_actions
519+ AuditLogsManager.get_actions_by_type
520+
521+
522+ AuditLog
523+ ........
524+
525+ AuditLog objects are returned by the various AuditLogsManager methods.
526+
527+ .. autosummary ::
528+ :toctree: generated/
529+
530+ AuditLog
531+
532+
533+ PrivateConnectionsManager
534+ .........................
535+
536+ PrivateConnectionsManager objects are returned by the :func: `manage_private_connections ` function.
537+ They allow you to create and manage private connections in your organization.
538+
539+ .. currentmodule :: singlestoredb.management.private_connections
540+
541+ .. autosummary ::
542+ :toctree: generated/
543+
544+ PrivateConnectionsManager
545+ PrivateConnectionsManager.create_private_connection
546+ PrivateConnectionsManager.get_private_connection
547+ PrivateConnectionsManager.private_connections
548+ PrivateConnectionsManager.delete_private_connection
549+ PrivateConnectionsManager.update_private_connection
550+
551+
552+ PrivateConnection
553+ .................
554+
555+ PrivateConnection objects are retrieved from :meth: `PrivateConnectionsManager.get_private_connection `
556+ or by retrieving an element from :attr: `PrivateConnectionsManager.private_connections `.
557+
558+ .. autosummary ::
559+ :toctree: generated/
560+
561+ PrivateConnection
562+
563+
564+ PrivateConnectionKaiInfo
565+ ........................
566+
567+ PrivateConnectionKaiInfo objects contain KAI-specific information for private connections.
568+
569+ .. autosummary ::
570+ :toctree: generated/
571+
572+ PrivateConnectionKaiInfo
573+
574+
575+ PrivateConnectionOutboundAllowList
576+ ..................................
577+
578+ PrivateConnectionOutboundAllowList objects contain outbound allow list information for private connections.
579+
580+ .. autosummary ::
581+ :toctree: generated/
582+
583+ PrivateConnectionOutboundAllowList
584+
585+
586+ IdentityRole
587+ ............
588+
589+ IdentityRole objects are used by both teams and users management for role information.
590+
591+ .. currentmodule :: singlestoredb.management.teams
592+
593+ .. autosummary ::
594+ :toctree: generated/
595+
596+ IdentityRole
597+
598+
599+ Storage DR
600+ ----------
601+
602+ Storage Disaster Recovery objects provide information about replicated databases
603+ and disaster recovery regions.
604+
605+ .. currentmodule :: singlestoredb.management.storage_dr
606+
607+ .. autosummary ::
608+ :toctree: generated/
609+
610+ ReplicatedDatabase
611+ StorageDRStatus
612+ StorageDRRegion
613+
614+
615+ Metrics
616+ -------
617+
618+ Metrics objects provide workspace group metrics and data points.
619+
620+ .. currentmodule :: singlestoredb.management.metrics
621+
622+ .. autosummary ::
623+ :toctree: generated/
624+
625+ WorkspaceGroupMetric
626+ MetricDataPoint
627+
628+
433629Notebook Tools
434630--------------
435631
0 commit comments