jwttemplate

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 jwttemplate provides the JWT Templates API.

Index

• func Create(ctx context.Context, params *CreateParams) (*clerk.JWTTemplate, error)
• func Delete(ctx context.Context, id string) (*clerk.DeletedResource, error)
• func Get(ctx context.Context, id string) (*clerk.JWTTemplate, error)
• func List(ctx context.Context, params *ListParams) (*clerk.JWTTemplateList, error)
• func Update(ctx context.Context, id string, params *UpdateParams) (*clerk.JWTTemplate, error)
• type Client
  • func NewClient(config *clerk.ClientConfig) *Client
  • func (c *Client) Create(ctx context.Context, params *CreateParams) (*clerk.JWTTemplate, error)
  • func (c *Client) Delete(ctx context.Context, id string) (*clerk.DeletedResource, error)
  • func (c *Client) Get(ctx context.Context, id string) (*clerk.JWTTemplate, error)
  • func (c *Client) List(ctx context.Context, params *ListParams) (*clerk.JWTTemplateList, error)
  • func (c *Client) Update(ctx context.Context, id string, params *UpdateParams) (*clerk.JWTTemplate, error)
• type CreateParams
• type ListParams
• type UpdateParams

Functions

func Create

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

Create creates a new JWT template.

func Delete

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

Delete deletes a JWT template.

func Get

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

Get returns details about a JWT template.

func List

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

List returns a list of JWT templates.

func Update

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

Update updates the JWT template specified by id.

Types

type Client

type Client struct {
	Backend clerk.Backend
}

Client is used to invoke the JWT Templates API.

func NewClient

func NewClient(config *clerk.ClientConfig) *Client

func (*Client) Create

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

Create creates a new JWT template.

func (*Client) Delete

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

Delete deletes a JWT template.

func (*Client) Get

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

Get returns details about a JWT template.

func (*Client) List

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

List returns a list of JWT templates.

func (*Client) Update

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

Update updates the JWT template specified by id.

type CreateParams

type CreateParams struct {
	clerk.APIParams
	Name             *string         `json:"name,omitempty"`
	Claims           json.RawMessage `json:"claims,omitempty"`
	Lifetime         *int64          `json:"lifetime,omitempty"`
	AllowedClockSkew *int64          `json:"allowed_clock_skew,omitempty"`
	CustomSigningKey *bool           `json:"custom_signing_key,omitempty"`
	SigningKey       *string         `json:"signing_key,omitempty"`
	SigningAlgorithm *string         `json:"signing_algorithm,omitempty"`
}

type ListParams

type ListParams struct {
	clerk.APIParams
}

type UpdateParams

type UpdateParams struct {
	clerk.APIParams
	Name             *string         `json:"name,omitempty"`
	Claims           json.RawMessage `json:"claims,omitempty"`
	Lifetime         *int64          `json:"lifetime,omitempty"`
	AllowedClockSkew *int64          `json:"allowed_clock_skew,omitempty"`
	CustomSigningKey *bool           `json:"custom_signing_key,omitempty"`
	SigningKey       *string         `json:"signing_key,omitempty"`
	SigningAlgorithm *string         `json:"signing_algorithm,omitempty"`
}