github.com/goadesign/goa/examples/security/design

design

import "github.com/goadesign/goa/examples/security/design"

Overview

Index

Package files

design.go

Variables

var APIKeyAuth = APIKeySecurity("api_key", func() {
    Description("Secures endpoint by requiring an API key.")
})

APIKeyAuth defines a security scheme that uses API keys.

var BasicAuth = BasicAuthSecurity("basic", func() {
    Description("Basic authentication used to authenticate security principal during signin")
})

BasicAuth defines a security scheme using basic authentication. The scheme protects the “signin” action used to create JWTs.

var JWTAuth = JWTSecurity("jwt", func() {
    Description(`Secures endpoint by requiring a valid JWT token retrieved via the signin endpoint. Supports scopes "api:read" and "api:write".`)
    Scope("api:read", "Read-only access")
    Scope("api:write", "Read and write access")
})

JWTAuth defines a security scheme that uses JWT tokens.

var OAuth2Auth = OAuth2Security("oauth2", func() {
    AuthorizationCodeFlow("/authorization", "/token", "/refresh")
    Description(`Secures endpoint by requiring a valid OAuth2 token retrieved via the signin endpoint. Supports scopes "api:read" and "api:write".`)
    Scope("api:read", "Read-only access")
    Scope("api:write", "Read and write access")
})

OAuth2Auth defines a security scheme that uses OAuth2 tokens.

Generated by godoc2md