| 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). |
|---|
<?php namespace dtos;
use DateTime;
use Exception;
use DateInterval;
use JsonSerializable;
use ServiceStack\{IReturn,IReturnVoid,IGet,IPost,IPut,IDelete,IPatch,IMeta,IHasSessionId,IHasBearerToken,IHasVersion};
use ServiceStack\{ICrud,ICreateDb,IUpdateDb,IPatchDb,IDeleteDb,ISaveDb,AuditBase,QueryDb,QueryDb2,QueryData,QueryData2,QueryResponse};
use ServiceStack\{ResponseStatus,ResponseError,EmptyResponse,IdResponse,ArrayList,KeyValuePair2,StringResponse,StringsResponse,Tuple2,Tuple3,ByteArray};
use ServiceStack\{JsonConverters,Returns,TypeContext};
class ApiKeyResponse implements JsonSerializable
{
public function __construct(
/** @description The company the API key belongs to */
// @ApiMember(Description="The company the API key belongs to")
/** @var string */
public string $CompanyId='',
/** @description The API key value to send in the x-api-key header */
// @ApiMember(Description="The API key value to send in the x-api-key header")
/** @var string */
public string $ApiKey='',
/** @description Whether the key is active */
// @ApiMember(Description="Whether the key is active")
/** @var bool|null */
public ?bool $Active=null,
/** @description When the key was created */
// @ApiMember(Description="When the key was created")
/** @var DateTime */
public DateTime $CreatedDate=new DateTime(),
/** @description When the key expires, if ever */
// @ApiMember(Description="When the key expires, if ever")
/** @var DateTime|null */
public ?DateTime $ExpiryDate=null,
/** @description Contact email registered for the key */
// @ApiMember(Description="Contact email registered for the key")
/** @var string */
public string $ContactEmail='',
/** @description Free text notes for the key */
// @ApiMember(Description="Free text notes for the key")
/** @var string */
public string $Notes='',
/** @description Comma separated list of IP addresses the key is restricted to, if any */
// @ApiMember(Description="Comma separated list of IP addresses the key is restricted to, if any")
/** @var string */
public string $AllowedIpAddresses=''
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['CompanyId'])) $this->CompanyId = $o['CompanyId'];
if (isset($o['ApiKey'])) $this->ApiKey = $o['ApiKey'];
if (isset($o['Active'])) $this->Active = $o['Active'];
if (isset($o['CreatedDate'])) $this->CreatedDate = JsonConverters::from('DateTime', $o['CreatedDate']);
if (isset($o['ExpiryDate'])) $this->ExpiryDate = JsonConverters::from('DateTime', $o['ExpiryDate']);
if (isset($o['ContactEmail'])) $this->ContactEmail = $o['ContactEmail'];
if (isset($o['Notes'])) $this->Notes = $o['Notes'];
if (isset($o['AllowedIpAddresses'])) $this->AllowedIpAddresses = $o['AllowedIpAddresses'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->CompanyId)) $o['CompanyId'] = $this->CompanyId;
if (isset($this->ApiKey)) $o['ApiKey'] = $this->ApiKey;
if (isset($this->Active)) $o['Active'] = $this->Active;
if (isset($this->CreatedDate)) $o['CreatedDate'] = JsonConverters::to('DateTime', $this->CreatedDate);
if (isset($this->ExpiryDate)) $o['ExpiryDate'] = JsonConverters::to('DateTime', $this->ExpiryDate);
if (isset($this->ContactEmail)) $o['ContactEmail'] = $this->ContactEmail;
if (isset($this->Notes)) $o['Notes'] = $this->Notes;
if (isset($this->AllowedIpAddresses)) $o['AllowedIpAddresses'] = $this->AllowedIpAddresses;
return empty($o) ? new class(){} : $o;
}
}
class ApiKeyQueryResponse implements JsonSerializable
{
public function __construct(
/** @description The API keys for the company */
// @ApiMember(Description="The API keys for the company")
/** @var array<ApiKeyResponse>|null */
public ?array $ApiKeys=null,
/** @var ResponseStatus|null */
public ?ResponseStatus $ResponseStatus=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['ApiKeys'])) $this->ApiKeys = JsonConverters::fromArray('ApiKeyResponse', $o['ApiKeys']);
if (isset($o['ResponseStatus'])) $this->ResponseStatus = JsonConverters::from('ResponseStatus', $o['ResponseStatus']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->ApiKeys)) $o['ApiKeys'] = JsonConverters::toArray('ApiKeyResponse', $this->ApiKeys);
if (isset($this->ResponseStatus)) $o['ResponseStatus'] = JsonConverters::to('ResponseStatus', $this->ResponseStatus);
return empty($o) ? new class(){} : $o;
}
}
// @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)
class ApiKeyQuery implements ICompany, JsonSerializable
{
public function __construct(
/** @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. */
// @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")
/** @var string|null */
public ?string $CompanyId=null,
/** @description If true, only return keys that are active (not cancelled and not expired). Default is false (return all). */
// @ApiMember(DataType="boolean", Description="If true, only return keys that are active (not cancelled and not expired). Default is false (return all).", ParameterType="query")
/** @var bool|null */
public ?bool $ActiveOnly=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['CompanyId'])) $this->CompanyId = $o['CompanyId'];
if (isset($o['ActiveOnly'])) $this->ActiveOnly = $o['ActiveOnly'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->CompanyId)) $o['CompanyId'] = $this->CompanyId;
if (isset($this->ActiveOnly)) $o['ActiveOnly'] = $this->ActiveOnly;
return empty($o) ? new class(){} : $o;
}
}
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"}}}