actortoken

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 actortoken provides the Actor Tokens API.

Index

• func Create(ctx context.Context, params *CreateParams) (*clerk.ActorToken, error)
• func Revoke(ctx context.Context, id string) (*clerk.ActorToken, error)
• type Client
  • func NewClient(config *clerk.ClientConfig) *Client
  • func (c *Client) Create(ctx context.Context, params *CreateParams) (*clerk.ActorToken, error)
  • func (c *Client) Revoke(ctx context.Context, id string) (*clerk.ActorToken, error)
• type CreateParams

Functions

func Create

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

Create creates a new actor token.

func Revoke

func Revoke(ctx context.Context, id string) (*clerk.ActorToken, error)

Revoke revokes a pending actor token.

Types

type Client

type Client struct {
	Backend clerk.Backend
}

Client is used to invoke the Actor Tokens API.

func NewClient

func NewClient(config *clerk.ClientConfig) *Client

func (*Client) Create

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

Create creates a new actor token.

func (*Client) Revoke

func (c *Client) Revoke(ctx context.Context, id string) (*clerk.ActorToken, error)

Revoke revokes a pending actor token.

type CreateParams

type CreateParams struct {
	clerk.APIParams
	UserID                      *string         `json:"user_id,omitempty"`
	Actor                       json.RawMessage `json:"actor,omitempty"`
	ExpiresInSeconds            *int64          `json:"expires_in_seconds,omitempty"`
	SessionMaxDurationInSeconds *int64          `json:"session_max_duration_in_seconds,omitempty"`
}