| Requires any of the roles: | bookingsupplier-administrator-write, superadmin |
| 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). |
|---|
namespace BokaMera.API.ServiceModel.Dtos
open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations
[<AllowNullLiteral>]
type ApiKeyResponse() =
///<summary>
///The company the API key belongs to
///</summary>
[<ApiMember(Description="The company the API key belongs to")>]
member val CompanyId:Guid = new Guid() with 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")>]
member val ApiKey:Guid = new Guid() with get,set
///<summary>
///Whether the key is active
///</summary>
[<ApiMember(Description="Whether the key is active")>]
member val Active:Boolean = new Boolean() with get,set
///<summary>
///When the key was created
///</summary>
[<ApiMember(Description="When the key was created")>]
member val CreatedDate:DateTime = new DateTime() with get,set
///<summary>
///When the key expires, if ever
///</summary>
[<ApiMember(Description="When the key expires, if ever")>]
member val ExpiryDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set
///<summary>
///Contact email registered for the key
///</summary>
[<ApiMember(Description="Contact email registered for the key")>]
member val ContactEmail:String = null with get,set
///<summary>
///Free text notes for the key
///</summary>
[<ApiMember(Description="Free text notes for the key")>]
member val Notes:String = null with 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")>]
member val AllowedIpAddresses:String = null with get,set
[<AllowNullLiteral>]
type ApiKeyQueryResponse() =
///<summary>
///The API keys for the company
///</summary>
[<ApiMember(Description="The API keys for the company")>]
member val ApiKeys:ResizeArray<ApiKeyResponse> = null with get,set
member val ResponseStatus:ResponseStatus = null with get,set
[<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)>]
[<AllowNullLiteral>]
type ApiKeyQuery() =
///<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")>]
member val CompanyId:Nullable<Guid> = new Nullable<Guid>() with 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")>]
member val ActiveOnly:Nullable<Boolean> = new Nullable<Boolean>() with get,set
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /apikeys HTTP/1.1 Host: api.bookmore.com Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
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"}}}