< Summary - Jellyfin

Information
Class: Jellyfin.Api.Controllers.ApiKeyController
Assembly: Jellyfin.Api
File(s): /srv/git/jellyfin/Jellyfin.Api/Controllers/ApiKeyController.cs
Line coverage
0%
Covered lines: 0
Uncovered lines: 12
Coverable lines: 12
Total lines: 77
Line coverage: 0%
Branch coverage
N/A
Covered branches: 0
Total branches: 0
Branch coverage: N/A
Method coverage

Feature is only available for sponsors

Upgrade to PRO version

Coverage history

Coverage history 0 25 50 75 100 1/23/2026 - 12:11:06 AM Line coverage: 0% (0/3) Total lines: 764/19/2026 - 12:14:27 AM Line coverage: 0% (0/12) Total lines: 764/27/2026 - 12:15:04 AM Line coverage: 0% (0/12) Total lines: 77

Coverage delta

Coverage delta 1 -1

Metrics

MethodBranch coverage Crap Score Cyclomatic complexity Line coverage
.ctor(...)100%210%
GetKeys()100%210%
CreateKey()100%210%
RevokeKey()100%210%

File(s)

/srv/git/jellyfin/Jellyfin.Api/Controllers/ApiKeyController.cs

#LineLine coverage
 1using System.ComponentModel.DataAnnotations;
 2using System.Threading.Tasks;
 3using Jellyfin.Api.Constants;
 4using MediaBrowser.Common.Api;
 5using MediaBrowser.Controller.Security;
 6using MediaBrowser.Model.Querying;
 7using Microsoft.AspNetCore.Authorization;
 8using Microsoft.AspNetCore.Http;
 9using Microsoft.AspNetCore.Mvc;
 10
 11namespace Jellyfin.Api.Controllers;
 12
 13/// <summary>
 14/// Authentication controller.
 15/// </summary>
 16[Route("Auth")]
 17[Tags("Authentication")]
 18public class ApiKeyController : BaseJellyfinApiController
 19{
 20    private readonly IAuthenticationManager _authenticationManager;
 21
 22    /// <summary>
 23    /// Initializes a new instance of the <see cref="ApiKeyController"/> class.
 24    /// </summary>
 25    /// <param name="authenticationManager">Instance of <see cref="IAuthenticationManager"/> interface.</param>
 026    public ApiKeyController(IAuthenticationManager authenticationManager)
 27    {
 028        _authenticationManager = authenticationManager;
 029    }
 30
 31    /// <summary>
 32    /// Get all keys.
 33    /// </summary>
 34    /// <response code="200">Api keys retrieved.</response>
 35    /// <returns>A <see cref="QueryResult{AuthenticationInfo}"/> with all keys.</returns>
 36    [HttpGet("Keys")]
 37    [Authorize(Policy = Policies.RequiresElevation)]
 38    [ProducesResponseType(StatusCodes.Status200OK)]
 39    public async Task<ActionResult<QueryResult<AuthenticationInfo>>> GetKeys()
 40    {
 041        var keys = await _authenticationManager.GetApiKeys().ConfigureAwait(false);
 42
 043        return new QueryResult<AuthenticationInfo>(keys);
 044    }
 45
 46    /// <summary>
 47    /// Create a new api key.
 48    /// </summary>
 49    /// <param name="app">Name of the app using the authentication key.</param>
 50    /// <response code="204">Api key created.</response>
 51    /// <returns>A <see cref="NoContentResult"/>.</returns>
 52    [HttpPost("Keys")]
 53    [Authorize(Policy = Policies.RequiresElevation)]
 54    [ProducesResponseType(StatusCodes.Status204NoContent)]
 55    public async Task<ActionResult> CreateKey([FromQuery, Required] string app)
 56    {
 057        await _authenticationManager.CreateApiKey(app).ConfigureAwait(false);
 58
 059        return NoContent();
 060    }
 61
 62    /// <summary>
 63    /// Remove an api key.
 64    /// </summary>
 65    /// <param name="key">The access token to delete.</param>
 66    /// <response code="204">Api key deleted.</response>
 67    /// <returns>A <see cref="NoContentResult"/>.</returns>
 68    [HttpDelete("Keys/{key}")]
 69    [Authorize(Policy = Policies.RequiresElevation)]
 70    [ProducesResponseType(StatusCodes.Status204NoContent)]
 71    public async Task<ActionResult> RevokeKey([FromRoute, Required] string key)
 72    {
 073        await _authenticationManager.DeleteApiKey(key).ConfigureAwait(false);
 74
 075        return NoContent();
 076    }
 77}