BokaMera.API.Host

ApiKeyQuery

**Requires Authentication**
Requires any of the roles:	bookingsupplier-administrator-write, superadmin

The following routes are available for this service:
GET	/apikeys	List the API keys for the logged in user's company	Returns the API keys belonging to the company of the currently logged in user. A company administrator only ever sees the keys for their own company. Use the returned ApiKey value as the x-api-key header when calling the API (for example from an MCP server).

using System;
using System.IO;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using BokaMera.API.ServiceModel.Dtos;

namespace BokaMera.API.ServiceModel.Dtos
{
    [ApiResponse(Description="Returned if the current user is not authenticated", StatusCode=401)]
    [ApiResponse(Description="Returned if the current user does not have the required role", StatusCode=403)]
    public partial class ApiKeyQuery
        : ICompany
    {
        ///<summary>
        ///The company to list API keys for. Defaults to the logged in user's company. Only a SuperAdmin may specify a company other than their own; for other roles this value is ignored.
        ///</summary>
        [ApiMember(Description="The company to list API keys for. Defaults to the logged in user's company. Only a SuperAdmin may specify a company other than their own; for other roles this value is ignored.", ParameterType="query")]
        public virtual Guid? CompanyId { get; set; }

        ///<summary>
        ///If true, only return keys that are active (not cancelled and not expired). Default is false (return all).
        ///</summary>
        [ApiMember(DataType="boolean", Description="If true, only return keys that are active (not cancelled and not expired). Default is false (return all).", ParameterType="query")]
        public virtual bool? ActiveOnly { get; set; }
    }

    public partial class ApiKeyQueryResponse
    {
        ///<summary>
        ///The API keys for the company
        ///</summary>
        [ApiMember(Description="The API keys for the company")]
        public virtual List<ApiKeyResponse> ApiKeys { get; set; } = [];

        public virtual ResponseStatus ResponseStatus { get; set; }
    }

    public partial class ApiKeyResponse
    {
        ///<summary>
        ///The company the API key belongs to
        ///</summary>
        [ApiMember(Description="The company the API key belongs to")]
        public virtual Guid CompanyId { get; set; }

        ///<summary>
        ///The API key value to send in the x-api-key header
        ///</summary>
        [ApiMember(Description="The API key value to send in the x-api-key header")]
        public virtual Guid ApiKey { get; set; }

        ///<summary>
        ///Whether the key is active
        ///</summary>
        [ApiMember(Description="Whether the key is active")]
        public virtual bool Active { get; set; }

        ///<summary>
        ///When the key was created
        ///</summary>
        [ApiMember(Description="When the key was created")]
        public virtual DateTime CreatedDate { get; set; }

        ///<summary>
        ///When the key expires, if ever
        ///</summary>
        [ApiMember(Description="When the key expires, if ever")]
        public virtual DateTime? ExpiryDate { get; set; }

        ///<summary>
        ///Contact email registered for the key
        ///</summary>
        [ApiMember(Description="Contact email registered for the key")]
        public virtual string ContactEmail { get; set; }

        ///<summary>
        ///Free text notes for the key
        ///</summary>
        [ApiMember(Description="Free text notes for the key")]
        public virtual string Notes { get; set; }

        ///<summary>
        ///Comma separated list of IP addresses the key is restricted to, if any
        ///</summary>
        [ApiMember(Description="Comma separated list of IP addresses the key is restricted to, if any")]
        public virtual string AllowedIpAddresses { get; set; }
    }

}

C# ApiKeyQuery DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /apikeys HTTP/1.1 
Host: testapi.bokamera.se 
Accept: text/jsv

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	ApiKeys: 
	[
		{
			Active: False,
			ExpiryDate: "0001-01-01T00:00:00",
			ContactEmail: String,
			Notes: String,
			AllowedIpAddresses: String
		}
	],
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}