scim

type Email ¶

type Email struct {
	Value   string `json:"value"`
	Type    string `json:"type,omitempty"`
	Primary bool   `json:"primary,omitempty"`
}

Email is one entry of a User's emails.

type Error ¶

type Error struct {
	Status   int
	ScimType string
	Detail   string
}

Error is the RFC 7644 error envelope. Status is the HTTP status the handler answers with; the wire form carries it as a string, as the RFC's examples do.

func NewError(status int, scimType, detail string) *Error

func (e *Error) Error() string

func (e *Error) MarshalJSON() ([]byte, error)

type Filter ¶

type Filter struct {
	// Attr is spelled as in the allowed list passed to ParseFilter, whatever case the client used.
	Attr  string
	Value string
}

Filter is the one filter form Wardyn serves: `attr eq "value"`.

type Group ¶

type Group struct {
	Schemas     []string `json:"schemas"`
	ID          string   `json:"id,omitempty"`
	ExternalID  string   `json:"externalId"`
	DisplayName string   `json:"displayName"`
	Members     []Member `json:"members,omitempty"`
	Meta        *Meta    `json:"meta,omitempty"`
}

Group is the SCIM Group subset Wardyn serves. ExternalID is required for the same reason as User's.

type ListResponse ¶

type ListResponse[T any] struct {
	Schemas      []string `json:"schemas"`
	TotalResults int      `json:"totalResults"`
	StartIndex   int      `json:"startIndex"`
	ItemsPerPage int      `json:"itemsPerPage"`
	Resources    []T      `json:"Resources"`
}

ListResponse is the RFC 7644 list envelope. Wardyn does no paging, so StartIndex is always 1.

func NewListResponse[T any](resources []T) ListResponse[T]

type Member ¶

type Member struct {
	Value   string `json:"value"`
	Ref     string `json:"$ref,omitempty"`
	Display string `json:"display,omitempty"`
}

Member is one entry of a Group's members or of a members PatchOp value. Ref is `$ref`, which Entra sends as null.

type Meta ¶

type Meta struct {
	ResourceType string `json:"resourceType,omitempty"`
	Created      string `json:"created,omitempty"`
	LastModified string `json:"lastModified,omitempty"`
	Location     string `json:"location,omitempty"`
}

Meta is the resource metadata block. A client's meta is ignored on input.

type Op ¶

type Op struct {
	Index int
	Kind  OpKind
	Attr  string
	Value any
}

Op is one resolved PatchOp change. A path-less replace carrying a value object becomes one Op per key, all with the same Index.

Value by Attr: AttrActive is a bool (Entra's string "False" and "True" are accepted); AttrUserName, AttrExternalID, AttrDisplayName and AttrEmail are a non-empty string; AttrMembers is a []Member (a filter-path remove becomes one member; nil on a remove means every member); any other attribute is its json.RawMessage, unvalidated, for the caller to ignore. A remove carries a nil Value except for members. The `emails[type eq "work"]` selector is dropped: Wardyn keeps one address per person.

type OpError ¶

type OpError struct {
	Index int
	*Error
}

OpError reports one invalid operation of a PATCH by its position in Operations.

type OpKind ¶

type OpKind string

OpKind is a PatchOp operation, normalised to lower case.

const (
	OpAdd     OpKind = "add"
	OpReplace OpKind = "replace"
	OpRemove  OpKind = "remove"
)

type PatchError ¶

type PatchError struct {
	*Error
	Invalid []OpError
}

PatchError is the refusal of a whole PATCH. Invalid is empty when the request envelope itself was bad (not JSON, wrong schema, no Operations).

type User ¶

type User struct {
	Schemas     []string `json:"schemas"`
	ID          string   `json:"id,omitempty"`
	ExternalID  string   `json:"externalId"`
	UserName    string   `json:"userName"`
	DisplayName string   `json:"displayName,omitempty"`
	Emails      []Email  `json:"emails,omitempty"`
	Active      bool     `json:"active"`
	// ActiveSet is whether the body named active at all; a PUT that omits it leaves the identity as it is.
	ActiveSet bool  `json:"-"`
	Meta      *Meta `json:"meta,omitempty"`
}

User is the SCIM User subset Wardyn serves. Attributes outside it are dropped on parse.

ExternalID is required: Entra's default mapping sends the Entra objectId as externalId, and Wardyn binds the projection to a sign-in identity through it. ParseUser refuses a User without one.