Jan 30, 2025 · Jan 29, 2025 · Jan 30, 2025
diff --git a/coderd/apidoc/docs.go b/coderd/apidoc/docs.go
diff --git a/coderd/apidoc/swagger.json b/coderd/apidoc/swagger.json
diff --git a/coderd/idpsync/idpsync.go b/coderd/idpsync/idpsync.go
 type IDPSync interface {
 OrganizationSyncEntitled() bool
 OrganizationSyncSettings(ctx context.Context, db database.Store) (*OrganizationSyncSettings, error)
 UpdateOrganizationSettings(ctx context.Context, db database.Store, settings OrganizationSyncSettings) error
 UpdateOrganizationSyncSettings(ctx context.Context, db database.Store, settings OrganizationSyncSettings) error
 // OrganizationSyncEnabled returns true if all OIDC users are assigned
 // to organizations via org sync settings.
 // This is used to know when to disable manual org membership assignment.
 SyncRoles(ctx context.Context, db database.Store, user database.User, params RoleParams) error
 }

 // AGPLIDPSync implements the IDPSync interface
 var _ IDPSync = AGPLIDPSync{}

 // AGPLIDPSync is the configuration for syncing user information from an external
 // IDP. All related code to syncing user information should be in this package.
 type AGPLIDPSync struct {
diff --git a/coderd/idpsync/organization.go b/coderd/idpsync/organization.go
 return false
 }

 func (s AGPLIDPSync)UpdateOrganizationSettings(ctx context.Context, db database.Store, settings OrganizationSyncSettings) error {
 func (s AGPLIDPSync)UpdateOrganizationSyncSettings(ctx context.Context, db database.Store, settings OrganizationSyncSettings) error {
 rlv := s.Manager.Resolver(db)
 err := s.SyncSettings.Organization.SetRuntimeValue(ctx, rlv, &settings)
 if err != nil {
diff --git a/coderd/runtimeconfig/resolver.go b/coderd/runtimeconfig/resolver.go
 "github.com/coder/coder/v2/coderd/database"
 )

 // NoopResolver implements the Resolver interface
 var _ Resolver = &NoopResolver{}

 // NoopResolver is a useful test device.
 type NoopResolver struct{}

 return ErrEntryNotFound
 }

 // StoreResolver implements the Resolver interface
 var _ Resolver = &StoreResolver{}

 // StoreResolver uses the database as the underlying store for runtime settings.
 type StoreResolver struct {
 db Store
diff --git a/coderd/telemetry/telemetry_test.go b/coderd/telemetry/telemetry_test.go
 org, err := db.GetDefaultOrganization(ctx)
 require.NoError(t, err)
 sync := idpsync.NewAGPLSync(testutil.Logger(t), runtimeconfig.NewManager(), idpsync.DeploymentSyncSettings{})
 err = sync.UpdateOrganizationSettings(ctx, db, idpsync.OrganizationSyncSettings{
 err = sync.UpdateOrganizationSyncSettings(ctx, db, idpsync.OrganizationSyncSettings{
 Field: "organizations",
 Mapping: map[string][]uuid.UUID{
 "first": {org.ID},
diff --git a/codersdk/idpsync.go b/codersdk/idpsync.go
 "golang.org/x/xerrors"
 )

 // constraining to `uuid.UUID | string` here would be nice but `make gen` will
 // yell at you for it.
 type IDPSyncMapping[ResourceIdType uuid.UUID | string] struct {
 // The IdP claim the user has
 Given string
 // The ID of the Coder resource the user should be added to
 Gets ResourceIdType
 }

 type GroupSyncSettings struct {
 // Field is the name of the claim field that specifies what groups a user
 // should be in. If empty, no groups will be synced.
 return resp, json.NewDecoder(res.Body).Decode(&resp)
 }

 // If the same mapping is present in both Add and Remove, Remove will take presidence.
 type PatchOrganizationIDPSyncMappingRequest struct {
 Add    []IDPSyncMapping[uuid.UUID]
 Remove []IDPSyncMapping[uuid.UUID]
 }

 func (c *Client) PatchOrganizationIDPSyncMapping(ctx context.Context, req PatchOrganizationIDPSyncMappingRequest) (OrganizationSyncSettings, error) {
 res, err := c.Request(ctx, http.MethodPatch, "/api/v2/settings/idpsync/organization/mapping", req)
 if err != nil {
 return OrganizationSyncSettings{}, xerrors.Errorf("make request: %w", err)
 }
 defer res.Body.Close()

 if res.StatusCode != http.StatusOK {
 return OrganizationSyncSettings{}, ReadBodyAsError(res)
 }
 var resp OrganizationSyncSettings
 return resp, json.NewDecoder(res.Body).Decode(&resp)
 }

 func (c *Client) GetAvailableIDPSyncFields(ctx context.Context) ([]string, error) {
 res, err := c.Request(ctx, http.MethodGet, "/api/v2/settings/idpsync/available-fields", nil)
 if err != nil {
diff --git a/docs/reference/api/enterprise.md b/docs/reference/api/enterprise.md
diff --git a/docs/reference/api/schemas.md b/docs/reference/api/schemas.md
Original file line number	Diff line number	Diff line change
Expand Up		@@ -26,7 +26,7 @@ import (
		type IDPSync interface {
		OrganizationSyncEntitled() bool
		OrganizationSyncSettings(ctx context.Context, db database.Store) (*OrganizationSyncSettings, error)
		UpdateOrganizationSettings(ctx context.Context, db database.Store, settings OrganizationSyncSettings) error
		UpdateOrganizationSyncSettings(ctx context.Context, db database.Store, settings OrganizationSyncSettings) error
		// OrganizationSyncEnabled returns true if all OIDC users are assigned
		// to organizations via org sync settings.
		// This is used to know when to disable manual org membership assignment.
Expand DownExpand Up		@@ -70,6 +70,9 @@ type IDPSync interface {
		SyncRoles(ctx context.Context, db database.Store, user database.User, params RoleParams) error
		}

		// AGPLIDPSync implements the IDPSync interface
		var _ IDPSync = AGPLIDPSync{}

		// AGPLIDPSync is the configuration for syncing user information from an external
		// IDP. All related code to syncing user information should be in this package.
		type AGPLIDPSync struct {
Expand Down
Original file line number	Diff line number	Diff line change
Expand Up		@@ -34,7 +34,7 @@ func (AGPLIDPSync) OrganizationSyncEnabled(_ context.Context, _ database.Store)
		return false
		}

		func (s AGPLIDPSync)UpdateOrganizationSettings(ctx context.Context, db database.Store, settings OrganizationSyncSettings) error {
		func (s AGPLIDPSync)UpdateOrganizationSyncSettings(ctx context.Context, db database.Store, settings OrganizationSyncSettings) error {
		rlv := s.Manager.Resolver(db)
		err := s.SyncSettings.Organization.SetRuntimeValue(ctx, rlv, &settings)
		if err != nil {
Expand Down
Original file line number	Diff line number	Diff line change
Expand Up		@@ -12,6 +12,9 @@ import (
		"github.com/coder/coder/v2/coderd/database"
		)

		// NoopResolver implements the Resolver interface
		var _ Resolver = &NoopResolver{}

		// NoopResolver is a useful test device.
		type NoopResolver struct{}

Expand All		@@ -31,6 +34,9 @@ func (NoopResolver) DeleteRuntimeConfig(context.Context, string) error {
		return ErrEntryNotFound
		}

		// StoreResolver implements the Resolver interface
		var _ Resolver = &StoreResolver{}

		// StoreResolver uses the database as the underlying store for runtime settings.
		type StoreResolver struct {
		db Store
Expand Down
Original file line number	Diff line number	Diff line change
Expand Up		@@ -295,7 +295,7 @@ func TestTelemetry(t *testing.T) {
		org, err := db.GetDefaultOrganization(ctx)
		require.NoError(t, err)
		sync := idpsync.NewAGPLSync(testutil.Logger(t), runtimeconfig.NewManager(), idpsync.DeploymentSyncSettings{})
		err = sync.UpdateOrganizationSettings(ctx, db, idpsync.OrganizationSyncSettings{
		err = sync.UpdateOrganizationSyncSettings(ctx, db, idpsync.OrganizationSyncSettings{
		Field: "organizations",
		Mapping: map[string][]uuid.UUID{
		"first": {org.ID},
Expand Down
Original file line number	Diff line number	Diff line change
Expand Up		@@ -12,6 +12,15 @@ import (
		"golang.org/x/xerrors"
		)

		// constraining to `uuid.UUID \| string` here would be nice but `make gen` will
		// yell at you for it.
aslilac marked this conversation as resolved. Show resolvedHide resolved
		type IDPSyncMapping[ResourceIdType uuid.UUID \| string] struct {
		// The IdP claim the user has
		Given string
		// The ID of the Coder resource the user should be added to
		Gets ResourceIdType
		}

		type GroupSyncSettings struct {
		// Field is the name of the claim field that specifies what groups a user
		// should be in. If empty, no groups will be synced.
Expand DownExpand Up		@@ -137,6 +146,26 @@ func (c *Client) PatchOrganizationIDPSyncSettings(ctx context.Context, req Organ
		return resp, json.NewDecoder(res.Body).Decode(&resp)
		}

		// If the same mapping is present in both Add and Remove, Remove will take presidence.
		type PatchOrganizationIDPSyncMappingRequest struct {
		Add []IDPSyncMapping[uuid.UUID]
		Remove []IDPSyncMapping[uuid.UUID]
		}

		func (c *Client) PatchOrganizationIDPSyncMapping(ctx context.Context, req PatchOrganizationIDPSyncMappingRequest) (OrganizationSyncSettings, error) {
		res, err := c.Request(ctx, http.MethodPatch, "/api/v2/settings/idpsync/organization/mapping", req)
		if err != nil {
		return OrganizationSyncSettings{}, xerrors.Errorf("make request: %w", err)
		}
		defer res.Body.Close()

		if res.StatusCode != http.StatusOK {
		return OrganizationSyncSettings{}, ReadBodyAsError(res)
		}
		var resp OrganizationSyncSettings
		return resp, json.NewDecoder(res.Body).Decode(&resp)
		}

		func (c *Client) GetAvailableIDPSyncFields(ctx context.Context) ([]string, error) {
		res, err := c.Request(ctx, http.MethodGet, "/api/v2/settings/idpsync/available-fields", nil)
		if err != nil {
Expand Down