scim

type Adapter struct {
	// Client provides access to the datasource.
	Client Client
}

type AdapterResponse struct {
	// StatusCode is an HTTP status code.
	StatusCode int

	// RetryAfterHeader is the Retry-After response HTTP header, if set.
	RetryAfterHeader string

	// Objects is the list of items returned by the datasource.
	// May be empty.
	Objects []map[string]any

	// NextCursor is the cursor that identifies the first object of the next page.
	// nil if this is the last page in this full sync.
	NextCursor string
}

type Client interface {
	// GetPage returns a page of JSON objects from the datasource for the
	// requested entity.
	// Returns a (possibly empty) list of JSON objects, each object being
	// unmarshaled into a map by Golang's JSON unmarshaler.
	GetPage(ctx context.Context, request *Request) (*AdapterResponse, *framework.Error)
}

type Config struct {
	// Common configuration
	*config.CommonConfig

	// QueryParams is an map containing the query parameters for each entity associated with this
	// datasource. The key is the entity's external_name, and the value is the QueryParams.
	QueryParams map[string]QueryParams `json:"queryParams,omitempty"`
}

type Datasource struct {
	Client *http.Client
}

type QueryParams struct {
	// Filter allows to request a subset of resources via the "filter" query parameter containing a filter expression
	Filter string `json:"filter,omitempty"`

	// SortBy allows to sort the returned resources via the "sortBy" query parameter
	SortBy string `json:"sortBy,omitempty"`

	// Ascending allows to specify the sort order via the "sortOrder" query parameter
	Ascending *bool `json:"ascending,omitempty"`
}

type Request struct {
	// BaseURL is the Base URL of the datasource to query. For example, "my.scim.server.com".
	BaseURL string

	// AuthorizationHeader is the Authorization header sent to the SCIM SoR.
	AuthorizationHeader string

	// PageSize is the maximum number of objects to return from the entity.
	PageSize int64

	// EntityExternalID is the external ID of the entity.
	// The external ID should match the API's resource name.
	EntityExternalID string

	// Cursor identifies the first object of the page to return, as returned by
	// the last request for the entity.
	// Optional. If not set, return the first page for this entity.
	Cursor string

	// QueryParams contains the query parameters required to generate the URL for the datasource request
	QueryParams QueryParams

	// RequestTimeoutSeconds is the timeout duration for requests made to datasources.
	// This should be set to the number of seconds to wait before timing out.
	RequestTimeoutSeconds int
}

type Response struct {
	Resources    []map[string]any `json:"Resources"`
	TotalResults int64            `json:"totalResults"`
	StartIndex   int64            `json:"startIndex"`
	ItemsPerPage int64            `json:"itemsPerPage"`
}