Interface IApiTokenController

Namespace: DotNetNuke.Web.Api.Auth.ApiTokens
Assembly: DotNetNuke.Web.dll
Syntax
public interface IApiTokenController

Properties

SchemeType

Declaration
string SchemeType { get; }
Property Value
Type Description
string

Methods

ApiTokenKeyList(ApiTokenScope, string)

Declaration
SortedDictionary<string, ApiTokenAttribute> ApiTokenKeyList(ApiTokenScope scope, string locale)
Parameters
Type Name Description
ApiTokenScope scope
string locale
Returns
Type Description
SortedDictionary<string, ApiTokenAttribute>

CreateApiToken(int, string, ApiTokenScope, DateTime, string, int)

Declaration
string CreateApiToken(int portalId, string tokenName, ApiTokenScope scope, DateTime expiresOn, string apiKeys, int userId)
Parameters
Type Name Description
int portalId
string tokenName
ApiTokenScope scope
DateTime expiresOn
string apiKeys
int userId
Returns
Type Description
string

DeleteExpiredAndRevokedApiTokens(int, int)

Declaration
void DeleteExpiredAndRevokedApiTokens(int portalId, int userId)
Parameters
Type Name Description
int portalId
int userId

GetApiToken(int)

Declaration
ApiToken GetApiToken(int apiTokenId)
Parameters
Type Name Description
int apiTokenId
Returns
Type Description
ApiToken

GetApiTokens(ApiTokenScope, bool, int, int, ApiTokenFilter, string, int, int)

Declaration
IPagedList<ApiToken> GetApiTokens(ApiTokenScope scope, bool includeNarrowerScopes, int portalId, int userId, ApiTokenFilter filter, string apiKey, int pageIndex, int pageSize)
Parameters
Type Name Description
ApiTokenScope scope
bool includeNarrowerScopes
int portalId
int userId
ApiTokenFilter filter
string apiKey
int pageIndex
int pageSize
Returns
Type Description
IPagedList<ApiToken>

GetCurrentThreadApiToken()

Declaration
ApiToken GetCurrentThreadApiToken()
Returns
Type Description
ApiToken

RevokeOrDeleteApiToken(ApiToken, bool, int)

Declaration
void RevokeOrDeleteApiToken(ApiToken token, bool delete, int userId)
Parameters
Type Name Description
ApiToken token
bool delete
int userId

SetApiTokenForRequest(ApiToken)

Declaration
void SetApiTokenForRequest(ApiToken token)
Parameters
Type Name Description
ApiToken token

ValidateToken(HttpRequestMessage)

Declaration
(ApiToken Token, UserInfo User) ValidateToken(HttpRequestMessage request)
Parameters
Type Name Description
HttpRequestMessage request
Returns
Type Description
(ApiToken Token, UserInfo User)

Extension Methods