client

package
v0.0.0-...-f825106 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Oct 20, 2022 License: Apache-2.0 Imports: 11 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Client

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

Client represents an object that acts on behalf of the user to interact with the SCIM server

func New

func New(baseURL string, options ...NewOption) *Client

New creates a Client instance. The `baseURL` parameter is required, and must point to the root of the SCIM server.

If you need to perform authentication, create an HTTP client that handles the authentication, and pass it as an option

func (*Client) Group

func (client *Client) Group() *GroupService

Group creates a new Service object to perform an operation

func (*Client) Meta

func (client *Client) Meta() *MetaService

Meta creates a new Service object to perform an operation

func (*Client) Search

func (client *Client) Search() *SearchCall

func (*Client) User

func (client *Client) User() *UserService

User creates a new Service object to perform an operation

type CreateGroupCall

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

CreateGroupCall is an encapsulation of a SCIM operation.

func (*CreateGroupCall) DisplayName

func (call *CreateGroupCall) DisplayName(in string) *CreateGroupCall

func (*CreateGroupCall) Do

func (call *CreateGroupCall) Do(ctx context.Context) (*resource.Group, error)

func (*CreateGroupCall) Extension

func (call *CreateGroupCall) Extension(uri string, value interface{}) *CreateGroupCall

Extension allows users to register an extension using the fully qualified URI

func (*CreateGroupCall) ExternalID

func (call *CreateGroupCall) ExternalID(in string) *CreateGroupCall

func (*CreateGroupCall) FromJSON

func (call *CreateGroupCall) FromJSON(data []byte) *CreateGroupCall

func (*CreateGroupCall) Members

func (call *CreateGroupCall) Members(in ...*resource.GroupMember) *CreateGroupCall

func (*CreateGroupCall) MembersFrom

func (call *CreateGroupCall) MembersFrom(v ...interface{}) *CreateGroupCall

func (*CreateGroupCall) Trace

func (call *CreateGroupCall) Trace(w io.Writer) *CreateGroupCall

type CreateUserCall

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

CreateUserCall is an encapsulation of a SCIM operation.

func (*CreateUserCall) Active

func (call *CreateUserCall) Active(in bool) *CreateUserCall

func (*CreateUserCall) Addresses

func (call *CreateUserCall) Addresses(in ...*resource.Address) *CreateUserCall

func (*CreateUserCall) DisplayName

func (call *CreateUserCall) DisplayName(in string) *CreateUserCall

func (*CreateUserCall) Do

func (call *CreateUserCall) Do(ctx context.Context) (*resource.User, error)

func (*CreateUserCall) Emails

func (call *CreateUserCall) Emails(in ...*resource.Email) *CreateUserCall

func (*CreateUserCall) Entitlements

func (call *CreateUserCall) Entitlements(in ...*resource.Entitlement) *CreateUserCall

func (*CreateUserCall) Extension

func (call *CreateUserCall) Extension(uri string, value interface{}) *CreateUserCall

Extension allows users to register an extension using the fully qualified URI

func (*CreateUserCall) ExternalID

func (call *CreateUserCall) ExternalID(in string) *CreateUserCall

func (*CreateUserCall) FromJSON

func (call *CreateUserCall) FromJSON(data []byte) *CreateUserCall

func (*CreateUserCall) IMS

func (call *CreateUserCall) IMS(in ...*resource.IMS) *CreateUserCall

func (*CreateUserCall) Locale

func (call *CreateUserCall) Locale(in string) *CreateUserCall

func (*CreateUserCall) Name

func (call *CreateUserCall) Name(in *resource.Names) *CreateUserCall

func (*CreateUserCall) NickName

func (call *CreateUserCall) NickName(in string) *CreateUserCall

func (*CreateUserCall) Password

func (call *CreateUserCall) Password(in string) *CreateUserCall

func (*CreateUserCall) PhoneNumbers

func (call *CreateUserCall) PhoneNumbers(in ...*resource.PhoneNumber) *CreateUserCall

func (*CreateUserCall) Photos

func (call *CreateUserCall) Photos(in ...*resource.Photo) *CreateUserCall

func (*CreateUserCall) PreferredLanguage

func (call *CreateUserCall) PreferredLanguage(in string) *CreateUserCall

func (*CreateUserCall) ProfileURL

func (call *CreateUserCall) ProfileURL(in string) *CreateUserCall

func (*CreateUserCall) Roles

func (call *CreateUserCall) Roles(in ...*resource.Role) *CreateUserCall

func (*CreateUserCall) Timezone

func (call *CreateUserCall) Timezone(in string) *CreateUserCall

func (*CreateUserCall) Title

func (call *CreateUserCall) Title(in string) *CreateUserCall

func (*CreateUserCall) Trace

func (call *CreateUserCall) Trace(w io.Writer) *CreateUserCall

func (*CreateUserCall) UserName

func (call *CreateUserCall) UserName(in string) *CreateUserCall

func (*CreateUserCall) UserType

func (call *CreateUserCall) UserType(in string) *CreateUserCall

func (*CreateUserCall) X509Certificates

func (call *CreateUserCall) X509Certificates(in ...*resource.X509Certificate) *CreateUserCall

type DeleteGroupCall

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

DeleteGroupCall is an encapsulation of a SCIM operation.

func (*DeleteGroupCall) DisplayName

func (call *DeleteGroupCall) DisplayName(in string) *DeleteGroupCall

func (*DeleteGroupCall) Do

func (call *DeleteGroupCall) Do(ctx context.Context) error

func (*DeleteGroupCall) ExternalID

func (call *DeleteGroupCall) ExternalID(in string) *DeleteGroupCall

func (*DeleteGroupCall) FromJSON

func (call *DeleteGroupCall) FromJSON(data []byte) *DeleteGroupCall

func (*DeleteGroupCall) ID

func (call *DeleteGroupCall) ID(in string) *DeleteGroupCall

func (*DeleteGroupCall) Members

func (call *DeleteGroupCall) Members(in ...*resource.GroupMember) *DeleteGroupCall

func (*DeleteGroupCall) MembersFrom

func (call *DeleteGroupCall) MembersFrom(in ...interface{}) *DeleteGroupCall

func (*DeleteGroupCall) Meta

func (call *DeleteGroupCall) Meta(in *resource.Meta) *DeleteGroupCall

func (*DeleteGroupCall) Schemas

func (call *DeleteGroupCall) Schemas(in ...string) *DeleteGroupCall

func (*DeleteGroupCall) Trace

func (call *DeleteGroupCall) Trace(w io.Writer) *DeleteGroupCall

type DeleteUserCall

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

DeleteUserCall is an encapsulation of a SCIM operation.

func (*DeleteUserCall) Do

func (call *DeleteUserCall) Do(ctx context.Context) error

func (*DeleteUserCall) Trace

func (call *DeleteUserCall) Trace(w io.Writer) *DeleteUserCall

type GetGroupCall

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

GetGroupCall is an encapsulation of a SCIM operation.

func (*GetGroupCall) Attributes

func (call *GetGroupCall) Attributes(in ...string) *GetGroupCall

func (*GetGroupCall) Do

func (call *GetGroupCall) Do(ctx context.Context) (*resource.Group, error)

func (*GetGroupCall) ExcludedAttributes

func (call *GetGroupCall) ExcludedAttributes(in ...string) *GetGroupCall

func (*GetGroupCall) FromJSON

func (call *GetGroupCall) FromJSON(data []byte) *GetGroupCall

func (*GetGroupCall) Trace

func (call *GetGroupCall) Trace(w io.Writer) *GetGroupCall

type GetResourceTypesCall

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

GetResourceTypesCall is an encapsulation of a SCIM operation.

func (*GetResourceTypesCall) Do

func (*GetResourceTypesCall) Trace

type GetSchema

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

GetSchema is an encapsulation of a SCIM operation.

func (*GetSchema) Do

func (call *GetSchema) Do(ctx context.Context) (*resource.Schema, error)

func (*GetSchema) Trace

func (call *GetSchema) Trace(w io.Writer) *GetSchema

type GetSchemas

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

GetSchemas is an encapsulation of a SCIM operation.

func (*GetSchemas) Do

func (*GetSchemas) Trace

func (call *GetSchemas) Trace(w io.Writer) *GetSchemas

type GetServiceProviderConfigCall

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

GetServiceProviderConfigCall is an encapsulation of a SCIM operation.

func (*GetServiceProviderConfigCall) Do

func (*GetServiceProviderConfigCall) Trace

type GetUserCall

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

GetUserCall is an encapsulation of a SCIM operation.

func (*GetUserCall) Attributes

func (call *GetUserCall) Attributes(in ...string) *GetUserCall

func (*GetUserCall) Do

func (call *GetUserCall) Do(ctx context.Context) (*resource.User, error)

func (*GetUserCall) ExcludedAttributes

func (call *GetUserCall) ExcludedAttributes(in ...string) *GetUserCall

func (*GetUserCall) FromJSON

func (call *GetUserCall) FromJSON(data []byte) *GetUserCall

func (*GetUserCall) Trace

func (call *GetUserCall) Trace(w io.Writer) *GetUserCall

type GroupService

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

func (*GroupService) Create

func (svc *GroupService) Create() *CreateGroupCall

func (*GroupService) Delete

func (svc *GroupService) Delete(id string) *DeleteGroupCall

func (*GroupService) Get

func (svc *GroupService) Get(id string) *GetGroupCall

func (*GroupService) Patch

func (svc *GroupService) Patch(id string) *PatchGroupCall

Patch allows the user to patch parts of the group object

func (*GroupService) Replace

func (svc *GroupService) Replace(id string) *ReplaceGroupCall

func (*GroupService) Search

func (svc *GroupService) Search() *SearchGroupCall

type HTTPClient

type HTTPClient interface {
	Do(*http.Request) (*http.Response, error)
}

type MetaService

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

func (*MetaService) GetResourceTypes

func (svc *MetaService) GetResourceTypes() *GetResourceTypesCall

func (*MetaService) GetSchema

func (svc *MetaService) GetSchema(id string) *GetSchema

func (*MetaService) GetSchemas

func (svc *MetaService) GetSchemas() *GetSchemas

func (*MetaService) GetServiceProviderConfig

func (svc *MetaService) GetServiceProviderConfig() *GetServiceProviderConfigCall

type NewOption

type NewOption interface {
	Option
	// contains filtered or unexported methods
}

NewOption is a type of option that can be passed to `client.New()`

func WithClient

func WithClient(v HTTPClient) NewOption

WithClient specifies the http.Client instance to use.

func WithTrace

func WithTrace(v io.Writer) NewOption

WithTrace allows users to specify a destination to write out the details of a request

type Option

type Option = option.Interface

type PatchGroupCall

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

PatchGroupCall is an encapsulation of a SCIM operation.

func (*PatchGroupCall) Do

func (call *PatchGroupCall) Do(ctx context.Context) (*resource.Group, error)

func (*PatchGroupCall) Extension

func (call *PatchGroupCall) Extension(uri string, value interface{}) *PatchGroupCall

Extension allows users to register an extension using the fully qualified URI

func (*PatchGroupCall) FromJSON

func (call *PatchGroupCall) FromJSON(data []byte) *PatchGroupCall

func (*PatchGroupCall) Operations

func (call *PatchGroupCall) Operations(in ...*resource.PatchOperation) *PatchGroupCall

func (*PatchGroupCall) Schemas

func (call *PatchGroupCall) Schemas(in ...string) *PatchGroupCall

func (*PatchGroupCall) Trace

func (call *PatchGroupCall) Trace(w io.Writer) *PatchGroupCall

type PatchUserCall

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

PatchUserCall is an encapsulation of a SCIM operation.

func (*PatchUserCall) Do

func (call *PatchUserCall) Do(ctx context.Context) (*resource.User, error)

func (*PatchUserCall) Extension

func (call *PatchUserCall) Extension(uri string, value interface{}) *PatchUserCall

Extension allows users to register an extension using the fully qualified URI

func (*PatchUserCall) FromJSON

func (call *PatchUserCall) FromJSON(data []byte) *PatchUserCall

func (*PatchUserCall) Operations

func (call *PatchUserCall) Operations(in ...*resource.PatchOperation) *PatchUserCall

func (*PatchUserCall) Schemas

func (call *PatchUserCall) Schemas(in ...string) *PatchUserCall

func (*PatchUserCall) Trace

func (call *PatchUserCall) Trace(w io.Writer) *PatchUserCall

type ReplaceGroupCall

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

ReplaceGroupCall is an encapsulation of a SCIM operation.

func (*ReplaceGroupCall) DisplayName

func (call *ReplaceGroupCall) DisplayName(in string) *ReplaceGroupCall

func (*ReplaceGroupCall) Do

func (call *ReplaceGroupCall) Do(ctx context.Context) (*resource.Group, error)

func (*ReplaceGroupCall) Extension

func (call *ReplaceGroupCall) Extension(uri string, value interface{}) *ReplaceGroupCall

Extension allows users to register an extension using the fully qualified URI

func (*ReplaceGroupCall) ExternalID

func (call *ReplaceGroupCall) ExternalID(in string) *ReplaceGroupCall

func (*ReplaceGroupCall) FromJSON

func (call *ReplaceGroupCall) FromJSON(data []byte) *ReplaceGroupCall

func (*ReplaceGroupCall) Members

func (call *ReplaceGroupCall) Members(in ...*resource.GroupMember) *ReplaceGroupCall

func (*ReplaceGroupCall) Trace

func (call *ReplaceGroupCall) Trace(w io.Writer) *ReplaceGroupCall

type ReplaceUserCall

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

ReplaceUserCall is an encapsulation of a SCIM operation.

func (*ReplaceUserCall) Active

func (call *ReplaceUserCall) Active(in bool) *ReplaceUserCall

func (*ReplaceUserCall) Addresses

func (call *ReplaceUserCall) Addresses(in ...*resource.Address) *ReplaceUserCall

func (*ReplaceUserCall) DisplayName

func (call *ReplaceUserCall) DisplayName(in string) *ReplaceUserCall

func (*ReplaceUserCall) Do

func (call *ReplaceUserCall) Do(ctx context.Context) (*resource.User, error)

func (*ReplaceUserCall) Emails

func (call *ReplaceUserCall) Emails(in ...*resource.Email) *ReplaceUserCall

func (*ReplaceUserCall) Entitlements

func (call *ReplaceUserCall) Entitlements(in ...*resource.Entitlement) *ReplaceUserCall

func (*ReplaceUserCall) Extension

func (call *ReplaceUserCall) Extension(uri string, value interface{}) *ReplaceUserCall

Extension allows users to register an extension using the fully qualified URI

func (*ReplaceUserCall) ExternalID

func (call *ReplaceUserCall) ExternalID(in string) *ReplaceUserCall

func (*ReplaceUserCall) FromJSON

func (call *ReplaceUserCall) FromJSON(data []byte) *ReplaceUserCall

func (*ReplaceUserCall) IMS

func (call *ReplaceUserCall) IMS(in ...*resource.IMS) *ReplaceUserCall

func (*ReplaceUserCall) Locale

func (call *ReplaceUserCall) Locale(in string) *ReplaceUserCall

func (*ReplaceUserCall) Name

func (call *ReplaceUserCall) Name(in *resource.Names) *ReplaceUserCall

func (*ReplaceUserCall) NickName

func (call *ReplaceUserCall) NickName(in string) *ReplaceUserCall

func (*ReplaceUserCall) Password

func (call *ReplaceUserCall) Password(in string) *ReplaceUserCall

func (*ReplaceUserCall) PhoneNumbers

func (call *ReplaceUserCall) PhoneNumbers(in ...*resource.PhoneNumber) *ReplaceUserCall

func (*ReplaceUserCall) Photos

func (call *ReplaceUserCall) Photos(in ...*resource.Photo) *ReplaceUserCall

func (*ReplaceUserCall) PreferredLanguage

func (call *ReplaceUserCall) PreferredLanguage(in string) *ReplaceUserCall

func (*ReplaceUserCall) ProfileURL

func (call *ReplaceUserCall) ProfileURL(in string) *ReplaceUserCall

func (*ReplaceUserCall) Roles

func (call *ReplaceUserCall) Roles(in ...*resource.Role) *ReplaceUserCall

func (*ReplaceUserCall) Timezone

func (call *ReplaceUserCall) Timezone(in string) *ReplaceUserCall

func (*ReplaceUserCall) Title

func (call *ReplaceUserCall) Title(in string) *ReplaceUserCall

func (*ReplaceUserCall) Trace

func (call *ReplaceUserCall) Trace(w io.Writer) *ReplaceUserCall

func (*ReplaceUserCall) UserName

func (call *ReplaceUserCall) UserName(in string) *ReplaceUserCall

func (*ReplaceUserCall) UserType

func (call *ReplaceUserCall) UserType(in string) *ReplaceUserCall

func (*ReplaceUserCall) X509Certificates

func (call *ReplaceUserCall) X509Certificates(in ...*resource.X509Certificate) *ReplaceUserCall

type RequestOption

type RequestOption interface {
	Option
	// contains filtered or unexported methods
}

RequestOption is a type of option that can be passed to any of the client request methods.

type SearchCall

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

SearchCall is an encapsulation of a SCIM operation.

func (*SearchCall) Attributes

func (call *SearchCall) Attributes(in ...string) *SearchCall

func (*SearchCall) Count

func (call *SearchCall) Count(in int) *SearchCall

func (*SearchCall) Do

func (*SearchCall) ExcludedAttributes

func (call *SearchCall) ExcludedAttributes(in ...string) *SearchCall

func (*SearchCall) Extension

func (call *SearchCall) Extension(uri string, value interface{}) *SearchCall

Extension allows users to register an extension using the fully qualified URI

func (*SearchCall) Filter

func (call *SearchCall) Filter(in string) *SearchCall

func (*SearchCall) FromJSON

func (call *SearchCall) FromJSON(data []byte) *SearchCall

func (*SearchCall) Schema

func (call *SearchCall) Schema(in string) *SearchCall

func (*SearchCall) Schemas

func (call *SearchCall) Schemas(in ...string) *SearchCall

func (*SearchCall) SortBy

func (call *SearchCall) SortBy(in string) *SearchCall

func (*SearchCall) SortOrder

func (call *SearchCall) SortOrder(in string) *SearchCall

func (*SearchCall) StartIndex

func (call *SearchCall) StartIndex(in int) *SearchCall

func (*SearchCall) Trace

func (call *SearchCall) Trace(w io.Writer) *SearchCall

type SearchGroupCall

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

SearchGroupCall is an encapsulation of a SCIM operation.

func (*SearchGroupCall) Attributes

func (call *SearchGroupCall) Attributes(in ...string) *SearchGroupCall

func (*SearchGroupCall) Count

func (call *SearchGroupCall) Count(in int) *SearchGroupCall

func (*SearchGroupCall) Do

func (*SearchGroupCall) ExcludedAttributes

func (call *SearchGroupCall) ExcludedAttributes(in ...string) *SearchGroupCall

func (*SearchGroupCall) Extension

func (call *SearchGroupCall) Extension(uri string, value interface{}) *SearchGroupCall

Extension allows users to register an extension using the fully qualified URI

func (*SearchGroupCall) Filter

func (call *SearchGroupCall) Filter(in string) *SearchGroupCall

func (*SearchGroupCall) FromJSON

func (call *SearchGroupCall) FromJSON(data []byte) *SearchGroupCall

func (*SearchGroupCall) Schema

func (call *SearchGroupCall) Schema(in string) *SearchGroupCall

func (*SearchGroupCall) Schemas

func (call *SearchGroupCall) Schemas(in ...string) *SearchGroupCall

func (*SearchGroupCall) SortBy

func (call *SearchGroupCall) SortBy(in string) *SearchGroupCall

func (*SearchGroupCall) SortOrder

func (call *SearchGroupCall) SortOrder(in string) *SearchGroupCall

func (*SearchGroupCall) StartIndex

func (call *SearchGroupCall) StartIndex(in int) *SearchGroupCall

func (*SearchGroupCall) Trace

func (call *SearchGroupCall) Trace(w io.Writer) *SearchGroupCall

type SearchService

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

func (*SearchService) Search

func (svc *SearchService) Search() *SearchCall

type SearchUserCall

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

SearchUserCall is an encapsulation of a SCIM operation.

func (*SearchUserCall) Attributes

func (call *SearchUserCall) Attributes(in ...string) *SearchUserCall

func (*SearchUserCall) Count

func (call *SearchUserCall) Count(in int) *SearchUserCall

func (*SearchUserCall) Do

func (*SearchUserCall) ExcludedAttributes

func (call *SearchUserCall) ExcludedAttributes(in ...string) *SearchUserCall

func (*SearchUserCall) Extension

func (call *SearchUserCall) Extension(uri string, value interface{}) *SearchUserCall

Extension allows users to register an extension using the fully qualified URI

func (*SearchUserCall) Filter

func (call *SearchUserCall) Filter(in string) *SearchUserCall

func (*SearchUserCall) FromJSON

func (call *SearchUserCall) FromJSON(data []byte) *SearchUserCall

func (*SearchUserCall) Schema

func (call *SearchUserCall) Schema(in string) *SearchUserCall

func (*SearchUserCall) Schemas

func (call *SearchUserCall) Schemas(in ...string) *SearchUserCall

func (*SearchUserCall) SortBy

func (call *SearchUserCall) SortBy(in string) *SearchUserCall

func (*SearchUserCall) SortOrder

func (call *SearchUserCall) SortOrder(in string) *SearchUserCall

func (*SearchUserCall) StartIndex

func (call *SearchUserCall) StartIndex(in int) *SearchUserCall

func (*SearchUserCall) Trace

func (call *SearchUserCall) Trace(w io.Writer) *SearchUserCall

type UserService

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

UserService the logical grouping of SCIM user related API calls

func (*UserService) Create

func (svc *UserService) Create() *CreateUserCall

Create creates an insance of CreateUserCall that sends an HTTP POST request to /Users to create a new user.

func (*UserService) Delete

func (svc *UserService) Delete(id string) *DeleteUserCall

func (*UserService) Get

func (svc *UserService) Get(id string) *GetUserCall

Get creates an instance of GetUserCall that sends an HTTP GET request to /Users to retrieve the user associated with the specified ID.

func (*UserService) Patch

func (svc *UserService) Patch(id string) *PatchUserCall

Patch allows the user to patch parts of the user object

func (*UserService) Replace

func (svc *UserService) Replace(id string) *ReplaceUserCall

Replace creates an insance of ReplaceUserCall that sends an HTTP PUT request to /Users to replace an existing new user.

func (*UserService) Search

func (svc *UserService) Search() *SearchUserCall

Jump to

Keyboard shortcuts

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