Skip to main content

AuthN | Go SDK | Invite Endpoints

Invite Endpoints

Invite User

func (a *User) Invite(ctx context.Context, input UserInviteRequest) (*pangea.PangeaResponse[UserInviteResult], error)

Send an invitation to a user.

required parameters

context.Context
UserInviteRequest
input := authn.UserInviteRequest{
	Inviter: "admin@email.com",
	Email: "joe.user@email.com",
	Callback: "https://www.myserver.com/callback",
	State: "pcb_zurr3lkcwdp5keq73htsfpcii5k4zgm7",
}

resp, err := authncli.User.Invite(ctx, input)

Delete Invite

func (a *UserInvite) Delete(ctx context.Context, input UserInviteDeleteRequest) (*pangea.PangeaResponse[UserInviteDeleteResult], error)

Delete a user invitation.

required parameters

context.Context
UserInviteDeleteRequest
input := authn.UserInviteDeleteRequest{
	ID: "pmc_wuk7tvtpswyjtlsx52b7yyi2l7zotv4a",
}

resp, err := authncli.User.Invite.Delete(ctx, input)

List Invites

func (a *UserInvite) List(ctx context.Context, input UserInviteListRequest) (*pangea.PangeaResponse[UserInviteListResult], error)

Look up active invites for the userpool.

required parameters

context.Context
UserInviteListRequest
input := authn.UserInviteListRequest{}
resp, err := authncli.User.Invite.List(ctx, input)

Type ItemOrder

type ItemOrder string
type ItemOrder string

Type UserInviteDeleteRequest

type UserInviteDeleteRequest struct

required parameters

pangea.BaseRequest

Base request has ConfigID for multi-config projects

string `json:"id"`
type UserInviteDeleteRequest struct {
	// Base request has ConfigID for multi-config projects
	pangea.BaseRequest

	ID	string	`json:"id"`
}

Type UserInviteListOrderBy

type UserInviteListOrderBy string
type UserInviteListOrderBy string

Type UserInviteListRequest

type UserInviteListRequest struct

required parameters

pangea.BaseRequest

Base request has ConfigID for multi-config projects

pangea.Filter `json:"filter,omitempty"`

Should use FilterUserInviteList object here

string `json:"last,omitempty"`
ItemOrder `json:"order,omitempty"`
UserInviteListOrderBy `json:"order_by,omitempty"`
int `json:"size,omitempty"`
type UserInviteListRequest struct {
	// Base request has ConfigID for multi-config projects
	pangea.BaseRequest

	// Should use FilterUserInviteList object here
	Filter	pangea.Filter		`json:"filter,omitempty"`
	Last	string			`json:"last,omitempty"`
	Order	ItemOrder		`json:"order,omitempty"`
	OrderBy	UserInviteListOrderBy	`json:"order_by,omitempty"`
	Size	int			`json:"size,omitempty"`
}

Type UserInviteRequest

type UserInviteRequest struct

required parameters

pangea.BaseRequest

Base request has ConfigID for multi-config projects

string `json:"inviter"`
string `json:"email"`
string `json:"callback"`
string `json:"state"`
type UserInviteRequest struct {
	// Base request has ConfigID for multi-config projects
	pangea.BaseRequest

	Inviter		string	`json:"inviter"`
	Email		string	`json:"email"`
	Callback	string	`json:"callback"`
	State		string	`json:"state"`
}