| 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). |
|---|
import 'package:servicestack/servicestack.dart';
class ApiKeyResponse implements IConvertible
{
/**
* The company the API key belongs to
*/
// @ApiMember(Description="The company the API key belongs to")
String CompanyId = "";
/**
* 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")
String ApiKey = "";
/**
* Whether the key is active
*/
// @ApiMember(Description="Whether the key is active")
bool Active;
/**
* When the key was created
*/
// @ApiMember(Description="When the key was created")
DateTime CreatedDate = DateTime(0);
/**
* When the key expires, if ever
*/
// @ApiMember(Description="When the key expires, if ever")
DateTime? ExpiryDate;
/**
* Contact email registered for the key
*/
// @ApiMember(Description="Contact email registered for the key")
String ContactEmail = "";
/**
* Free text notes for the key
*/
// @ApiMember(Description="Free text notes for the key")
String Notes = "";
/**
* 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")
String AllowedIpAddresses = "";
ApiKeyResponse({this.CompanyId,this.ApiKey,this.Active,this.CreatedDate,this.ExpiryDate,this.ContactEmail,this.Notes,this.AllowedIpAddresses});
ApiKeyResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
CompanyId = json['CompanyId'];
ApiKey = json['ApiKey'];
Active = json['Active'];
CreatedDate = JsonConverters.fromJson(json['CreatedDate'],'DateTime',context!);
ExpiryDate = JsonConverters.fromJson(json['ExpiryDate'],'DateTime',context!);
ContactEmail = json['ContactEmail'];
Notes = json['Notes'];
AllowedIpAddresses = json['AllowedIpAddresses'];
return this;
}
Map<String, dynamic> toJson() => {
'CompanyId': CompanyId,
'ApiKey': ApiKey,
'Active': Active,
'CreatedDate': JsonConverters.toJson(CreatedDate,'DateTime',context!),
'ExpiryDate': JsonConverters.toJson(ExpiryDate,'DateTime',context!),
'ContactEmail': ContactEmail,
'Notes': Notes,
'AllowedIpAddresses': AllowedIpAddresses
};
getTypeName() => "ApiKeyResponse";
TypeContext? context = _ctx;
}
class ApiKeyQueryResponse implements IConvertible
{
/**
* The API keys for the company
*/
// @ApiMember(Description="The API keys for the company")
List<ApiKeyResponse> ApiKeys = [];
ResponseStatus ResponseStatus;
ApiKeyQueryResponse({this.ApiKeys,this.ResponseStatus});
ApiKeyQueryResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
ApiKeys = JsonConverters.fromJson(json['ApiKeys'],'List<ApiKeyResponse>',context!);
ResponseStatus = JsonConverters.fromJson(json['ResponseStatus'],'ResponseStatus',context!);
return this;
}
Map<String, dynamic> toJson() => {
'ApiKeys': JsonConverters.toJson(ApiKeys,'List<ApiKeyResponse>',context!),
'ResponseStatus': JsonConverters.toJson(ResponseStatus,'ResponseStatus',context!)
};
getTypeName() => "ApiKeyQueryResponse";
TypeContext? context = _ctx;
}
// @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, IConvertible
{
/**
* 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")
String? CompanyId;
/**
* 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")
bool? ActiveOnly;
ApiKeyQuery({this.CompanyId,this.ActiveOnly});
ApiKeyQuery.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
CompanyId = json['CompanyId'];
ActiveOnly = json['ActiveOnly'];
return this;
}
Map<String, dynamic> toJson() => {
'CompanyId': CompanyId,
'ActiveOnly': ActiveOnly
};
getTypeName() => "ApiKeyQuery";
TypeContext? context = _ctx;
}
TypeContext _ctx = TypeContext(library: 'api.bookmore.com', types: <String, TypeInfo> {
'ApiKeyResponse': TypeInfo(TypeOf.Class, create:() => ApiKeyResponse()),
'ApiKeyQueryResponse': TypeInfo(TypeOf.Class, create:() => ApiKeyQueryResponse()),
'List<ApiKeyResponse>': TypeInfo(TypeOf.Class, create:() => <ApiKeyResponse>[]),
'ApiKeyQuery': TypeInfo(TypeOf.Class, create:() => ApiKeyQuery()),
});
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
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: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<ApiKeyQueryResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
<ApiKeys>
<ApiKeyResponse>
<Active>false</Active>
<AllowedIpAddresses>String</AllowedIpAddresses>
<ApiKey>00000000-0000-0000-0000-000000000000</ApiKey>
<CompanyId>00000000-0000-0000-0000-000000000000</CompanyId>
<ContactEmail>String</ContactEmail>
<CreatedDate>0001-01-01T00:00:00</CreatedDate>
<ExpiryDate>0001-01-01T00:00:00</ExpiryDate>
<Notes>String</Notes>
</ApiKeyResponse>
</ApiKeys>
<ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
<d2p1:ErrorCode>String</d2p1:ErrorCode>
<d2p1:Message>String</d2p1:Message>
<d2p1:StackTrace>String</d2p1:StackTrace>
<d2p1:Errors>
<d2p1:ResponseError>
<d2p1:ErrorCode>String</d2p1:ErrorCode>
<d2p1:FieldName>String</d2p1:FieldName>
<d2p1:Message>String</d2p1:Message>
<d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:KeyValueOfstringstring>
<d5p1:Key>String</d5p1:Key>
<d5p1:Value>String</d5p1:Value>
</d5p1:KeyValueOfstringstring>
</d2p1:Meta>
</d2p1:ResponseError>
</d2p1:Errors>
<d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:KeyValueOfstringstring>
<d3p1:Key>String</d3p1:Key>
<d3p1:Value>String</d3p1:Value>
</d3p1:KeyValueOfstringstring>
</d2p1:Meta>
</ResponseStatus>
</ApiKeyQueryResponse>