scim

package

v0.1.0 Latest Latest Go to latest Published: Oct 27, 2025 License: Apache-2.0 Imports: 16 Imported by: 0

Documentation ¶

Index ¶

Constants
Variables
type BaseResource
type Client
- func NewClient(hostRef commoncfg.SourceRef, authRef commoncfg.SecretRef, logger hclog.Logger) (*Client, error)
- func (c *Client) GetGroup(ctx context.Context, id string, groupMemberAttribute string) (*Group, error)
- func (c *Client) GetUser(ctx context.Context, id string) (*User, error)
- func (c *Client) ListGroups(ctx context.Context, method string, filter FilterExpression, cursor *string, ...) (*GroupList, error)
- func (c *Client) ListUsers(ctx context.Context, method string, filter FilterExpression, cursor *string, ...) (*UserList, error)
type FilterComparison
- func (f FilterComparison) ToString() string
type FilterExpression
type FilterLogicalGroupAnd
- func (f FilterLogicalGroupAnd) ToString() string
type FilterLogicalGroupNot
- func (f FilterLogicalGroupNot) ToString() string
type FilterLogicalGroupOr
- func (f FilterLogicalGroupOr) ToString() string
type FilterOperator
type Group
type GroupList
type MultiValuedAttribute
type NullFilterExpression
- func (f NullFilterExpression) ToString() string
type SearchRequest
type User
type UserList

Constants ¶

const (
	ApplicationSCIMJson = "application/scim+json"

	SearchRequestSchema = "urn:ietf:params:scim:api:messages:2.0:SearchRequest"

	BasePathGroups = "/Groups"
	BasePathUsers  = "/Users"
	PostSearchPath = ".search"

	HeaderAuthorization = "Authorization"
)

Variables ¶

View Source

var (
	ErrAuthNotImplemented       = errors.New("API Auth not implemented")
	ErrGetUser                  = errors.New("error getting SCIM user")
	ErrListUsers                = errors.New("error listing SCIM users")
	ErrGetGroup                 = errors.New("error getting SCIM group")
	ErrListGroups               = errors.New("error listing SCIM groups")
	ErrHttpCreation             = errors.New("failed to create the http client")
	ErrClientHost               = errors.New("failed to load the client host")
	ErrClientID                 = errors.New("failed to load the client id")
	ErrClientSecret             = errors.New("failed to load the client secret")
	ErrParsingClientCertificate = errors.New("failed to parse client certificate x509 pair")
)

View Source

var (
	ErrNoFilter     = errors.New("filter not provided")
	ErrMarshallFail = errors.New("failed to marshal search request")
)

Functions ¶

This section is empty.

Types ¶

type BaseResource ¶

type BaseResource struct {
	ID         string   `json:"id"`
	ExternalID string   `json:"externalId,omitempty"`
	Meta       struct{} `json:"meta,omitempty"`
	Schemas    []string `json:"schemas,omitempty"`
}

type Client ¶

type Client struct {
	// contains filtered or unexported fields
}

func NewClient ¶

func NewClient(hostRef commoncfg.SourceRef, authRef commoncfg.SecretRef,
	logger hclog.Logger) (*Client, error)

func (*Client) GetGroup ¶

func (c *Client) GetGroup(ctx context.Context, id string, groupMemberAttribute string) (*Group, error)

GetGroup retrieves a SCIM group by its ID.

func (*Client) GetUser ¶

func (c *Client) GetUser(ctx context.Context, id string) (*User, error)

GetUser retrieves a SCIM user by its ID.

func (*Client) ListGroups ¶

func (c *Client) ListGroups(
	ctx context.Context,
	method string,
	filter FilterExpression,
	cursor *string,
	count *int,
) (*GroupList, error)

ListGroups retrieves a list of SCIM groups. It supports filtering, pagination (using cursor), and count parameters. The useHTTPPost parameter determines whether to use POST method + /.search path for the request.

func (*Client) ListUsers ¶

func (c *Client) ListUsers(
	ctx context.Context,
	method string,
	filter FilterExpression,
	cursor *string,
	count *int,
) (*UserList, error)

ListUsers retrieves a list of SCIM users. It supports filtering, pagination (using cursor), and count parameters. The useHTTPPost parameter determines whether to use POST method + /.search path for the request.

type FilterComparison ¶

type FilterComparison struct {
	Attribute string
	Operator  FilterOperator
	Value     string
}

FilterComparison represents a comparison filter expression.

func (FilterComparison) ToString ¶

func (f FilterComparison) ToString() string

type FilterExpression ¶

type FilterExpression interface {
	ToString() string
}

FilterExpression is an interface for filter expressions in SCIM. It can be a comparison or logical operation.

type FilterLogicalGroupAnd ¶

type FilterLogicalGroupAnd struct {
	Expressions []FilterExpression
}

FilterLogicalGroupAnd represents a logical AND group of filter expressions.

func (FilterLogicalGroupAnd) ToString ¶

func (f FilterLogicalGroupAnd) ToString() string

type FilterLogicalGroupNot ¶

type FilterLogicalGroupNot struct {
	Expression FilterExpression
}

FilterLogicalGroupNot represents a logical NOT operation on a filter expression.

func (FilterLogicalGroupNot) ToString ¶

func (f FilterLogicalGroupNot) ToString() string

type FilterLogicalGroupOr ¶

type FilterLogicalGroupOr struct {
	Expressions []FilterExpression
}

FilterLogicalGroupOr represents a logical OR group of filter expressions.

func (FilterLogicalGroupOr) ToString ¶

func (f FilterLogicalGroupOr) ToString() string

type FilterOperator ¶

type FilterOperator string

const (
	FilterOperatorEqual      FilterOperator = "eq"
	FilterOperatorGreater    FilterOperator = "gt"
	FilterOperatorEqualCI    FilterOperator = "eq_ci" // Case-insensitive
	FilterOperatorNotEqual   FilterOperator = "ne"
	FilterOperatorContains   FilterOperator = "co"
	FilterOperatorStartsWith FilterOperator = "sw"
	FilterOperatorEndsWith   FilterOperator = "ew"
)

type Group ¶

type Group struct {
	BaseResource

	DisplayName string                 `json:"displayName,omitempty"`
	Members     []MultiValuedAttribute `json:"members,omitempty"`
}

type GroupList ¶

type GroupList struct {
	Resources []Group `json:"Resources"`
}

type MultiValuedAttribute ¶

type MultiValuedAttribute struct {
	Primary bool   `json:"primary,omitempty"`
	Display string `json:"display,omitempty"`
	Value   string `json:"value"`
}

type NullFilterExpression ¶

type NullFilterExpression struct{}

NullFilterExpression is a placeholder for an empty/nil filter expression.

func (NullFilterExpression) ToString ¶

func (f NullFilterExpression) ToString() string

type SearchRequest ¶

type SearchRequest struct {
	Schemas []string `json:"schemas"`
	Filter  *string  `json:"filter,omitempty"`
	Count   *int     `json:"count,omitempty"`
	Cursor  *string  `json:"cursor,omitempty"`
}

type User ¶

type User struct {
	BaseResource

	UserName    string                 `json:"userName"`
	Name        struct{}               `json:"name"`
	DisplayName string                 `json:"displayName,omitempty"`
	Active      bool                   `json:"active"`
	Emails      []MultiValuedAttribute `json:"emails"`
	Groups      []MultiValuedAttribute `json:"groups"`
	UserType    string                 `json:"userType,omitempty"`
}

type UserList ¶

type UserList struct {
	Resources []User `json:"Resources"`
}

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL