Interface IApiTokenRepository

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

Methods

AddApiToken(ApiTokenBase, string, int)

Declaration
ApiToken AddApiToken(ApiTokenBase apiToken, string apiKeys, int userId)
Parameters
Type Name Description
ApiTokenBase apiToken
string apiKeys
int userId
Returns
Type Description
ApiToken

DeleteApiToken(ApiTokenBase)

Declaration
void DeleteApiToken(ApiTokenBase apiToken)
Parameters
Type Name Description
ApiTokenBase apiToken

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

GetApiToken(int, string)

Declaration
ApiToken GetApiToken(int portalId, string tokenHash)
Parameters
Type Name Description
int portalId
string tokenHash
Returns
Type Description
ApiToken

GetApiTokenKeys(int)

Declaration
List<string> GetApiTokenKeys(int apiTokenId)
Parameters
Type Name Description
int apiTokenId
Returns
Type Description
List<string>

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>

RevokeApiToken(ApiTokenBase, int)

Declaration
void RevokeApiToken(ApiTokenBase apiToken, int userId)
Parameters
Type Name Description
ApiTokenBase apiToken
int userId

SetApiTokenLastUsed(ApiTokenBase)

Declaration
void SetApiTokenLastUsed(ApiTokenBase apiToken)
Parameters
Type Name Description
ApiTokenBase apiToken

Extension Methods