| 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. |
|---|
import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*
@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)
open class CreateApiKey : ICompany
{
/**
* 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.
*/
@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.")
override var CompanyId:UUID? = null
/**
* Optional contact email to register for the key. Defaults to the logged in user's email.
*/
@ApiMember(Description="Optional contact email to register for the key. Defaults to the logged in user's email.")
open var ContactEmail:String? = null
/**
* Optional free text note for the key.
*/
@ApiMember(Description="Optional free text note for the key.")
open var Notes:String? = null
}
open class ApiKeyResponse
{
/**
* The company the API key belongs to
*/
@ApiMember(Description="The company the API key belongs to")
open var CompanyId:UUID? = 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")
open var ApiKey:UUID? = null
/**
* Whether the key is active
*/
@ApiMember(Description="Whether the key is active")
open var Active:Boolean? = null
/**
* When the key was created
*/
@ApiMember(Description="When the key was created")
open var CreatedDate:Date? = null
/**
* When the key expires, if ever
*/
@ApiMember(Description="When the key expires, if ever")
open var ExpiryDate:Date? = null
/**
* Contact email registered for the key
*/
@ApiMember(Description="Contact email registered for the key")
open var ContactEmail:String? = null
/**
* Free text notes for the key
*/
@ApiMember(Description="Free text notes for the key")
open var Notes:String? = 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")
open var AllowedIpAddresses:String? = null
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
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: text/jsv
Content-Type: text/jsv
Content-Length: length
{
CompanyId: 00000000-0000-0000-0000-000000000000,
ContactEmail: String,
Notes: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
Active: False,
ExpiryDate: "0001-01-01T00:00:00",
ContactEmail: String,
Notes: String,
AllowedIpAddresses: String
}