Open API Package

< All Topics

Attributes

BOA

public BOA()

BOAVersion

public BOAVersion(string Version)

BOAInfo

public BOAInfo(string Title, string Version)

BOAFunctionName

public BOAFunctionName(string Name)

BOASummary

public BOASummary(string description)

BOAParameter

public BOAParameter(string Name, string In, string Description, Type DataType = null, bool Required = false)

BOAProducesResponse

public BOAProducesResponse(Type Type, string DictionaryName = "", string DictionaryArg0 = "", string DictionaryArg1 = "")

BOARoute

public BOARoute(string Template)

BOAHttpGet

public BOAHttpGet()

BOAHttpPost

public BOAHttpPost()

Enviroment Variables

All of theses variables are in local.setting.json file and it is located in the path: Barracuda\Examples\OpenApiReader.Azure.Functions\local.settings.json

OAuth 2.0 & OpenID

OAuthUrl

This variable is used to set the url of the application to be used to authenticate the user. Example:
"OAuthUrl": "https://login.delivers.com/auth/realms/develop/protocol/openid-connect/auth"

OAuthTokenUrl

This variable is used to set the url of the authenticate application with the token. Example:
"OAuthTokenUrl": "https://login.delivers.com/auth/realms/develop/protocol/openid-connect/token"

OAuthClientId

This variable is used to set the client Id. Example:
"OAuthClientId": "delivers"

OAuthClientSecret

This variable is used to set the client secret. Example:
"OAuthClientSecret": "my secret id"

Scope

This variable is used to set the scope Example:
"Scope": "profile"

Client Grant Flow

JWTKey

This variable is to set the JSON Web Token key.

"JWTKey": "401b09eab3c013d4ca54922bb802bec8fd5318192b0a75f201d8b3727429090fb337591abd3e44453b954555b7a0812e1081c39b740293f765eae731f5a65ed1"

IUsser

This variable is to set the name of the issuing.

"IUsser": "Delivers"

Audencie

This variable is to set the public that is able to  receive data.

"Audencie": "AllUsers"

CookieToken

This variable is to set the name of the token used for client grant flow.

"CookieToken": "X-Access-Token"

CookieRefreshToken

This variable is to set the name of the refresh token used for the client grant flow.

"CookieRefreshToken": "X-Refresh-Token"

CookieTokenPath

This variable is to set the path of the token for client grant flow.

"CookieTokenPath": "/api"

CookieRefreshTokenPath

This variable is to set path of the refresh token for client grant flow.

"CookieRefreshTokenPath": "/api/permissions/Refresh"

BarracudaAuthUrl

This variable is to set the url Auth of the website.

"BarracudaAuthUrl": "https://www.mysite.dev:7070/api/permissions/Auth"

BarracudaRefreshTokenUrl

This variable is to set the url refresh token of the website.

"BarracudaRefreshTokenUrl": "https://www.mysite.dev:7070/api/permissions/RefreshToken"

BarracudaRefreshUrl

This variable is to set the url refresh of the website.

"BarracudaRefreshUrl": "https://www.mysite.dev:7070/api/permissions/Refresh"

Barracuda OpenID Soon...

BOAUrlJson

This variable is used to set url of the front view of OpenApi Barracuda. Example:
"BOAUrlJson": "http://localhost:3000/api/openApiDemos/openapi/v1"

BOARedirectAuthUrl

This variable is used to set url of the front view of OpenApi Barracuda in order to authenticate the user. Example:
"BOARedirectAuthUrl": "http://localhost:3000/api/openApiDemos/openapi/auth"

Methods

OpenAPI

public string Build(Assembly assembly, string typeName, HttpRequestMessage request)

OpenAPIUI

public string OpenAPIUI();

OpenAPIAuth

public string OpenAPIAuth();

Third Party Classes

System.Type

Represents type declarations: class types, interface types, array types, value types, enumeration types, type parameters, generic type definitions, and open or closed constructed generic types.

System.Reflection.Assembly

Represents an assembly, which is a reusable, versionable, and self-describing building block of a common language runtime application.

System.Net.Http.HttpRequestMessage

Represents a HTTP request message.

Video Tutorials

Download Barracuda from Github

In this video tutorial you will be guide step by step to how to clone the solucion Barracuda source code and examples from the website Github.

Barracuda OpenAPI 

In this video you will see the front view of barracuda openAPI package and how it is using the methods from Barracuda Identity Provider in order to valid if the user has the permissions to call an API function.

Create Certificate

There is a ReadMe.md file that contains extra information to know how to create a certificate for your application.

The ReadMe.md file is located in the path: Barracuda/blob/main/Examples/React/Source/README.md

Previous Identity Provider Package
Table of Contents