feat(scim): update documentation

Author: xlgmokha

internal/api/scim/core/attribute.go

@@ -42,15 +42,13 @@ func (a *Attribute) AsCaseExact() *Attribute {
 	return a
 }
 
-// Suggesting sets "canonicalValues", the values a client may send for this
-// attribute, e.g. "work" and "home".
+// Suggesting sets "canonicalValues", per RFC 7643, Section 7.
 func (a *Attribute) Suggesting(values ...string) *Attribute {
 	a.CanonicalValues = values
 	return a
 }
 
-// Referencing sets "referenceTypes", the resource types a reference attribute
-// may point at, either by name or as ReferenceExternal or ReferenceURI.
+// Referencing sets "referenceTypes", per RFC 7643, Section 7.
 func (a *Attribute) Referencing(referenceTypes ...ReferenceType) *Attribute {
 	a.ReferenceTypes = referenceTypes
 	return a

internal/api/scim/core/core.go

@@ -1,16 +1,15 @@
 // Package core implements the SCIM 2.0 core schema defined in RFC 7643.
 package core
 
-// SchemaURI identifies a SCIM schema
+// SchemaURI identifies a SCIM schema, per RFC 7643, Section 3.
 type SchemaURI string
 
-// ResourceTypeName names a resource type
+// ResourceTypeName names a resource type, per RFC 7643, Section 6.
 type ResourceTypeName string
 
 func (n ResourceTypeName) Reference() ReferenceType { return ReferenceType(n) }
 
-// ReferenceType is a value of "referenceTypes", per RFC 7643, Section 7:
-// a resource type name, or the reference-only "external" / "uri".
+// ReferenceType is a "referenceTypes" value, per RFC 7643, Section 7.
 type ReferenceType string
 
 // AttributeType is the data type of an attribute, per RFC 7643, Section 7.
@@ -26,7 +25,7 @@ const (
 	TypeComplex   AttributeType = "complex"
 )
 
-// Mutability states when an attribute may be (re)defined.
+// Mutability states when an attribute may be (re)defined, per RFC 7643, Section 7.
 type Mutability string
 
 const (
@@ -36,7 +35,7 @@ const (
 	MutabilityWriteOnly Mutability = "writeOnly"
 )
 
-// Returned states when an attribute is included in a response.
+// Returned states when an attribute is included in a response, per RFC 7643, Section 7.
 type Returned string
 
 const (
@@ -46,7 +45,7 @@ const (
 	ReturnedRequest Returned = "request"
 )
 
-// Uniqueness states how the service provider enforces uniqueness.
+// Uniqueness states how the service provider enforces uniqueness, per RFC 7643, Section 7.
 type Uniqueness string
 
 const (

internal/api/scim/models.go

@@ -51,7 +51,6 @@ func (e *Error) Error() string {
 	return message
 }
 
-// StatusCode is the HTTP status the Error was built from, or 500 if unparsable.
 func (e *Error) StatusCode() int {
 	status, err := strconv.Atoi(e.Status)
 	if err != nil {
@@ -60,7 +59,6 @@ func (e *Error) StatusCode() int {
 	return status
 }
 
-// Is reports whether target is an Error of the same status and scimType.
 func (e *Error) Is(target error) bool {
 	other, ok := target.(*Error)
 	return ok && other.Status == e.Status && other.ScimType == e.ScimType

internal/api/scim/protocol/error.go

@@ -11,7 +11,6 @@ import (
 // MediaType is the SCIM media type registered in RFC 7644, Section 8.1.
 const MediaType = "application/scim+json"
 
-// Send writes obj as a SCIM response.
 func Send(w http.ResponseWriter, status int, obj any) error {
 	var body []byte
 	if obj != nil {

internal/api/scim/protocol/protocol.go

@@ -46,11 +46,9 @@ type Limits struct {
 	MaxCount     int
 }
 
-// DefaultLimits are the bounds a provider gets until it states its own.
 var DefaultLimits = Limits{DefaultCount: 100, MaxCount: 100}
 
-// ParseSearchRequest reads the query parameters of RFC 7644, Section 3.4.2,
-// holding the client to this provider's Limits.
+// ParseSearchRequest reads the query parameters of RFC 7644, Section 3.4.2.
 func (l Limits) ParseSearchRequest(values url.Values) (*SearchRequest, error) {
 	startIndex, err := intParam(values, "startIndex", 1)
 	if err != nil {

internal/api/scim/protocol/search_request.go

@@ -7,6 +7,7 @@ import (
 	"fmt"
 	"strconv"
 	"strings"
+	"time"
 
 	"github.com/gofrs/uuid"
 	"github.com/jackc/pgconn"
@@ -29,6 +30,24 @@ const countUsers = `SELECT COUNT(*) FROM scim_users WHERE sso_provider_id = ? AN
 
 const listUsers = `SELECT id, resource, active, created_at, updated_at FROM scim_users WHERE sso_provider_id = ? AND deleted_at IS NULL ORDER BY %s LIMIT ? OFFSET ?`
 
+type scimUser struct {
+	ID        string    `db:"id"`
+	Resource  []byte    `db:"resource"`
+	Active    bool      `db:"active"`
+	CreatedAt time.Time `db:"created_at"`
+	UpdatedAt time.Time `db:"updated_at"`
+}
+
+func (scimUser) TableName() string {
+	return "scim_users"
+}
+
+func (u *scimUser) ResourceID() string { return u.ID }
+
+func (u *scimUser) Timestamps() (created, updated time.Time) {
+	return u.CreatedAt, u.UpdatedAt
+}
+
 type userRepository struct {
 	db      *storage.Connection
 	baseURL string
@@ -41,20 +60,6 @@ func NewUserRepository(db *storage.Connection, baseURL string) Repository[*core.
 	}
 }
 
-func (r *userRepository) Get(ctx context.Context, id string) (*core.User, error) {
-	var rows []scimUser
-
-	err := r.db.WithContext(ctx).RawQuery("SELECT id, resource, active, created_at, updated_at FROM scim_users WHERE sso_provider_id = ? AND deleted_at IS NULL AND id = ?", r.tenant(ctx), id).All(&rows)
-	if err != nil {
-		return nil, fmt.Errorf("scim: reading user: %w", err)
-	}
-
-	if len(rows) == 0 {
-		return nil, ErrNotFound
-	}
-	return r.mapFrom(&rows[0])
-}
-
 func (r *userRepository) List(ctx context.Context, query *protocol.SearchRequest) ([]*core.User, int, error) {
 	if query.Filter != "" {
 		return nil, 0, protocol.ErrInvalidFilter("filtering is not supported")
@@ -93,6 +98,20 @@ func (r *userRepository) List(ctx context.Context, query *protocol.SearchRequest
 	return users, total, nil
 }
 
+func (r *userRepository) Get(ctx context.Context, id string) (*core.User, error) {
+	var rows []scimUser
+
+	err := r.db.WithContext(ctx).RawQuery("SELECT id, resource, active, created_at, updated_at FROM scim_users WHERE sso_provider_id = ? AND deleted_at IS NULL AND id = ?", r.tenant(ctx), id).All(&rows)
+	if err != nil {
+		return nil, fmt.Errorf("scim: reading user: %w", err)
+	}
+
+	if len(rows) == 0 {
+		return nil, ErrNotFound
+	}
+	return r.mapFrom(&rows[0])
+}
+
 func (r *userRepository) Create(ctx context.Context, user *core.User) (*core.User, error) {
 	resource, err := r.toResource(user)
 	if err != nil {