claims

Documentation

Overview

Package claims provides the ability for inserting token claims resources into or extracting token claims resources from the middleware chain for the API.

Usage:

import "github.com/go-vela/server/router/middleware/claims"

Index

• func Establish() gin.HandlerFunc
• func FromContext(c context.Context) *token.Claims
• func Retrieve(c *gin.Context) *token.Claims
• func ToContext(c Setter, cl *token.Claims)
• type Setter

Functions

func Establish

func Establish() gin.HandlerFunc

Establish sets the claims in the given context.

func FromContext

func FromContext(c context.Context) *token.Claims

FromContext returns the Claims associated with this context.

func Retrieve

func Retrieve(c *gin.Context) *token.Claims

Retrieve gets the claims in the given context.

func ToContext

func ToContext(c Setter, cl *token.Claims)

ToContext adds the Claims to this context if it supports the Setter interface.

Types

type Setter

type Setter interface {
	Set(string, interface{})
}

Setter defines a context that enables setting values.