Add development section to readme (#2)

* Add development section to readme

* If server principal's name looks like an email address, store it as an email address on the user trait

* Add blurb to readme about required permissions and which tables are accessed.

Author: jirwin

README.md

@@ -6,19 +6,33 @@ It uses [go-mssqldb](https://github.com/microsoft/go-mssqldb) to connect to SQL
 Check out [Baton](https://github.com/conductorone/baton) to learn more the project in general.
 
 # Getting Started
+This connector requires that you connect to your  SQL Server instance with a user with the proper access to read the system tables. The following permissions are required:
+    - `VIEW ANY DEFINITION` on the server
+    - `VIEW ANY DATABASE` on the server
+    - `VIEW ANY DEFINITION` on each database
+    - `VIEW SERVER STATE` on the server
+    - `VIEW DATABASE STATE` on each database
+
+The following tables are read while syncing data with this connector:
+    - `sys.server_principals`
+    - `sys.databases`
+    - `sys.server_permissions`
+    - `sys.server_role_members`
+    - `sys.database_principals` on each database
+    - `sys.database_role_members` on each database
 
 ## brew
 
 ```
 brew install conductorone/baton/baton conductorone/baton/baton-sql-server
-baton-sql-server --dsn "server=127.0.0.1;user id=sa;password=P@ssw0rd;port=1433" 
+baton-sql-server --dsn "server=127.0.0.1;user id=sa;password=devP@ssw0rd;port=1433" 
 baton resources
 ```
 
 ## docker
 
 ```
-docker run --rm -v $(pwd):/out -e BATON_DSN="server=127.0.0.1;user id=sa;password=P@ssw0rd;port=1433" ghcr.io/conductorone/baton-sql-server:latest -f "/out/sync.c1z"
+docker run --rm -v $(pwd):/out -e BATON_DSN="server=127.0.0.1;user id=sa;password=devP@ssw0rd;port=1433" ghcr.io/conductorone/baton-sql-server:latest -f "/out/sync.c1z"
 docker run --rm -v $(pwd):/out ghcr.io/conductorone/baton:latest -f "/out/sync.c1z" resources
 ```
 
@@ -27,7 +41,7 @@ docker run --rm -v $(pwd):/out ghcr.io/conductorone/baton:latest -f "/out/sync.c
 ```
 go install github.com/conductorone/baton/cmd/baton@main
 go install github.com/conductorone/baton-sql-server/cmd/baton-sql-server@main
-baton-sql-server --dsn "server=127.0.0.1;user id=sa;password=P@ssw0rd;port=1433" 
+baton-sql-server --dsn "server=127.0.0.1;user id=sa;password=devP@ssw0rd;port=1433" 
 baton resources
 ```
 
@@ -42,6 +56,16 @@ baton resources
 
 When fetching database permissions, the server principal backing the database principal will the resource that is granted entitlements.
 
+# Development
+
+A docker compose file is included to easily spin up a SQL Server instance for development. To start the instance, run:
+
+```
+docker-compose up -d
+```
+
+The instance will be available at `localhost:1433`. The default username is `sa` and the default password is `devP@ssw0rd`.
+
 # Contributing, Support, and Issues
 
 We started Baton because we were tired of taking screenshots and manually building spreadsheets. We welcome contributions, and ideas, no matter how small -- our goal is to make identity and permissions sprawl less painful for everyone. If you have questions, problems, or ideas: Please open a Github Issue!

pkg/connector/server_user.go

@@ -2,6 +2,7 @@ package connector
 
 import (
 	"context"
+	"net/mail"
 
 	v2 "github.com/conductorone/baton-sdk/pb/c1/connector/v2"
 	"github.com/conductorone/baton-sdk/pkg/annotations"
@@ -45,11 +46,17 @@ func (d *userPrincipalSyncer) List(ctx context.Context, parentResourceID *v2.Res
 			status = v2.UserTrait_Status_STATUS_DISABLED
 		}
 
+		userOpts := []resource.UserTraitOption{resource.WithStatus(status)}
+
+		if _, err = mail.ParseAddress(principalModel.Name); err == nil {
+			userOpts = append(userOpts, resource.WithEmail(principalModel.Name, true))
+		}
+
 		r, err := resource.NewUserResource(
 			principalModel.Name,
 			d.ResourceType(ctx),
 			principalModel.ID,
-			[]resource.UserTraitOption{resource.WithStatus(status)},
+			userOpts,
 			resource.WithParentResourceID(parentResourceID),
 		)
 		if err != nil {