| Requires any of the roles: | bookingsupplier-administrator-write, superadmin |
| POST | /apikeys | Create a new API key for the logged in user's company | Generates a new API key for the company of the currently logged in user and returns it. A company administrator can only create keys for their own company. |
|---|
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
[<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 CreateApiKey() =
///<summary>
///The company to create the API key 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 create the API key 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.")>]
member val CompanyId:Nullable<Guid> = new Nullable<Guid>() with get,set
///<summary>
///Optional contact email to register for the key. Defaults to the logged in user's email.
///</summary>
[<ApiMember(Description="Optional contact email to register for the key. Defaults to the logged in user's email.")>]
member val ContactEmail:String = null with get,set
///<summary>
///Optional free text note for the key.
///</summary>
[<ApiMember(Description="Optional free text note for the key.")>]
member val Notes:String = null with get,set
To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /apikeys HTTP/1.1
Host: testapi.bokamera.se
Accept: application/json
Content-Type: application/json
Content-Length: length
{"CompanyId":"00000000-0000-0000-0000-000000000000","ContactEmail":"String","Notes":"String"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"Active":false,"ExpiryDate":"0001-01-01T00:00:00","ContactEmail":"String","Notes":"String","AllowedIpAddresses":"String"}