samlconnection

Documentation

Overview

Code generated by "gen"; DO NOT EDIT. This file is meant to be re-generated in place and/or deleted at any time.

Package samlconnection provides the SAML Connections API.

Index

• func Create(ctx context.Context, params *CreateParams) (*clerk.SAMLConnection, error)
• func Delete(ctx context.Context, id string) (*clerk.DeletedResource, error)
• func Get(ctx context.Context, id string) (*clerk.SAMLConnection, error)
• func List(ctx context.Context, params *ListParams) (*clerk.SAMLConnectionList, error)
• func Update(ctx context.Context, id string, params *UpdateParams) (*clerk.SAMLConnection, error)
• type AttributeMappingParams
• type Client
  • func NewClient(config *clerk.ClientConfig) *Client
  • func (c *Client) Create(ctx context.Context, params *CreateParams) (*clerk.SAMLConnection, error)
  • func (c *Client) Delete(ctx context.Context, id string) (*clerk.DeletedResource, error)
  • func (c *Client) Get(ctx context.Context, id string) (*clerk.SAMLConnection, error)
  • func (c *Client) List(ctx context.Context, params *ListParams) (*clerk.SAMLConnectionList, error)
  • func (c *Client) Update(ctx context.Context, id string, params *UpdateParams) (*clerk.SAMLConnection, error)
• type CreateParams
• type ListParams
  • func (params *ListParams) ToQuery() url.Values
• type UpdateParams

Functions

func Create

func Create(ctx context.Context, params *CreateParams) (*clerk.SAMLConnection, error)

Create creates a new SAML Connection.

func Delete

func Delete(ctx context.Context, id string) (*clerk.DeletedResource, error)

Delete deletes a SAML Connection.

func Get

func Get(ctx context.Context, id string) (*clerk.SAMLConnection, error)

Get returns details about a SAML Connection.

func List

func List(ctx context.Context, params *ListParams) (*clerk.SAMLConnectionList, error)

List returns a list of SAML Connections.

func Update

func Update(ctx context.Context, id string, params *UpdateParams) (*clerk.SAMLConnection, error)

Update updates the SAML Connection specified by id.

Types

type AttributeMappingParams

type AttributeMappingParams struct {
	UserID       string `json:"user_id"`
	EmailAddress string `json:"email_address"`
	FirstName    string `json:"first_name"`
	LastName     string `json:"last_name"`
}

type Client

type Client struct {
	Backend clerk.Backend
}

Client is used to invoke the SAML Connections API.

func NewClient

func NewClient(config *clerk.ClientConfig) *Client

func (*Client) Create

func (c *Client) Create(ctx context.Context, params *CreateParams) (*clerk.SAMLConnection, error)

Create creates a new SAML Connection.

func (*Client) Delete

func (c *Client) Delete(ctx context.Context, id string) (*clerk.DeletedResource, error)

Delete deletes a SAML Connection.

func (*Client) Get

func (c *Client) Get(ctx context.Context, id string) (*clerk.SAMLConnection, error)

Get returns details about a SAML Connection.

func (*Client) List

func (c *Client) List(ctx context.Context, params *ListParams) (*clerk.SAMLConnectionList, error)

List returns a list of SAML Connections.

func (*Client) Update

func (c *Client) Update(ctx context.Context, id string, params *UpdateParams) (*clerk.SAMLConnection, error)

Update updates the SAML Connection specified by id.

type CreateParams

type CreateParams struct {
	clerk.APIParams
	Name             *string                 `json:"name,omitempty"`
	Domain           *string                 `json:"domain,omitempty"`
	Provider         *string                 `json:"provider,omitempty"`
	IdpEntityID      *string                 `json:"idp_entity_id,omitempty"`
	IdpSsoURL        *string                 `json:"idp_sso_url,omitempty"`
	IdpCertificate   *string                 `json:"idp_certificate,omitempty"`
	IdpMetadataURL   *string                 `json:"idp_metadata_url,omitempty"`
	IdpMetadata      *string                 `json:"idp_metadata,omitempty"`
	AttributeMapping *AttributeMappingParams `json:"attribute_mapping,omitempty"`
}

type ListParams

type ListParams struct {
	clerk.APIParams
	clerk.ListParams
	Query   *string `json:"query,omitempty"`
	OrderBy *string `json:"order_by,omitempty"`
}

func (*ListParams) ToQuery

func (params *ListParams) ToQuery() url.Values

ToQuery returns query string values from the params.

type UpdateParams

type UpdateParams struct {
	clerk.APIParams
	Name               *string                 `json:"name,omitempty"`
	Domain             *string                 `json:"domain,omitempty"`
	IdpEntityID        *string                 `json:"idp_entity_id,omitempty"`
	IdpSsoURL          *string                 `json:"idp_sso_url,omitempty"`
	IdpCertificate     *string                 `json:"idp_certificate,omitempty"`
	IdpMetadataURL     *string                 `json:"idp_metadata_url,omitempty"`
	IdpMetadata        *string                 `json:"idp_metadata,omitempty"`
	AttributeMapping   *AttributeMappingParams `json:"attribute_mapping,omitempty"`
	Active             *bool                   `json:"active,omitempty"`
	SyncUserAttributes *bool                   `json:"sync_user_attributes,omitempty"`
	AllowSubdomains    *bool                   `json:"allow_subdomains,omitempty"`
	AllowIdpInitiated  *bool                   `json:"allow_idp_initiated,omitempty"`
}