Package com.inductiveautomation.ignition.gateway.auth.apitoken

Interface ApiTokenManager

public interface ApiTokenManager

Manages the API Tokens configured in the system and exposes a method for validating HTTP Requests against API Tokens configured in the system

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final record	ApiTokenManager.ApiTokenContext	Context object contains the name of the token associated with an HTTP Request as well as which security levels are granted to the token
static class	ApiTokenManager.TokenAccessControl

Field Summary

Fields

Modifier and Type	Field	Description
static final ResourceType	RESOURCE_TYPE
static final AccessControlStrategy	TOKEN_ACCESS
static final AccessControlStrategy	TOKEN_READ
static final AccessControlStrategy	TOKEN_WRITE

Method Summary

Modifier and Type	Method	Description
Optional<ApiTokenManager.ApiTokenContext>	validateRequest(RequestContext request)	Validate if the given request is authenticated with a valid token, and if so, return the security levels associated with the token.

Field Details

RESOURCE_TYPE

static final ResourceType RESOURCE_TYPE

TOKEN_ACCESS

static final AccessControlStrategy TOKEN_ACCESS

TOKEN_READ

static final AccessControlStrategy TOKEN_READ

TOKEN_WRITE

static final AccessControlStrategy TOKEN_WRITE

Method Details

validateRequest

Optional<ApiTokenManager.ApiTokenContext> validateRequest(RequestContext request)

Validate if the given request is authenticated with a valid token, and if so, return the security levels associated with the token.