| 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 java.math.*;
import java.util.*;
import java.io.InputStream;
import net.servicestack.client.*;
public class 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 static class ApiKeyQuery implements ICompany
{
/**
* 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")
public UUID CompanyId = null;
/**
* 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")
public Boolean ActiveOnly = null;
public UUID getCompanyId() { return CompanyId; }
public ApiKeyQuery setCompanyId(UUID value) { this.CompanyId = value; return this; }
public Boolean isActiveOnly() { return ActiveOnly; }
public ApiKeyQuery setActiveOnly(Boolean value) { this.ActiveOnly = value; return this; }
}
public static class ApiKeyQueryResponse
{
/**
* The API keys for the company
*/
@ApiMember(Description="The API keys for the company")
public ArrayList<ApiKeyResponse> ApiKeys = new ArrayList<ApiKeyResponse>();
public ResponseStatus ResponseStatus = null;
public ArrayList<ApiKeyResponse> getApiKeys() { return ApiKeys; }
public ApiKeyQueryResponse setApiKeys(ArrayList<ApiKeyResponse> value) { this.ApiKeys = value; return this; }
public ResponseStatus getResponseStatus() { return ResponseStatus; }
public ApiKeyQueryResponse setResponseStatus(ResponseStatus value) { this.ResponseStatus = value; return this; }
}
public static class ApiKeyResponse
{
/**
* The company the API key belongs to
*/
@ApiMember(Description="The company the API key belongs to")
public UUID CompanyId = null;
/**
* 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")
public UUID ApiKey = null;
/**
* Whether the key is active
*/
@ApiMember(Description="Whether the key is active")
public Boolean Active = null;
/**
* When the key was created
*/
@ApiMember(Description="When the key was created")
public Date CreatedDate = null;
/**
* When the key expires, if ever
*/
@ApiMember(Description="When the key expires, if ever")
public Date ExpiryDate = null;
/**
* Contact email registered for the key
*/
@ApiMember(Description="Contact email registered for the key")
public String ContactEmail = null;
/**
* Free text notes for the key
*/
@ApiMember(Description="Free text notes for the key")
public String Notes = null;
/**
* 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")
public String AllowedIpAddresses = null;
public UUID getCompanyId() { return CompanyId; }
public ApiKeyResponse setCompanyId(UUID value) { this.CompanyId = value; return this; }
public UUID getApiKey() { return ApiKey; }
public ApiKeyResponse setApiKey(UUID value) { this.ApiKey = value; return this; }
public Boolean isActive() { return Active; }
public ApiKeyResponse setActive(Boolean value) { this.Active = value; return this; }
public Date getCreatedDate() { return CreatedDate; }
public ApiKeyResponse setCreatedDate(Date value) { this.CreatedDate = value; return this; }
public Date getExpiryDate() { return ExpiryDate; }
public ApiKeyResponse setExpiryDate(Date value) { this.ExpiryDate = value; return this; }
public String getContactEmail() { return ContactEmail; }
public ApiKeyResponse setContactEmail(String value) { this.ContactEmail = value; return this; }
public String getNotes() { return Notes; }
public ApiKeyResponse setNotes(String value) { this.Notes = value; return this; }
public String getAllowedIpAddresses() { return AllowedIpAddresses; }
public ApiKeyResponse setAllowedIpAddresses(String value) { this.AllowedIpAddresses = value; return this; }
}
}
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: testapi.bokamera.se 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"}}}