POST example/api/apikey/generatesuperkey
https://app.bwz.se/bedrock/example/api/apikey/generatesuperkey
Create a new super API key
Request Information
URI Parameters
None.
Body Parameters
Can the api key be used for API requests
CreateSuperApiKeyArgsName | Description | Type | Additional information |
---|---|---|---|
Description |
A description of the api key usage |
string |
None. |
IsEnabled |
Can the api key be used for API requests |
boolean |
Required |
Request Formats
application/json, text/json
Sample:
{ "Description": "sample string 1", "IsEnabled": true }
application/xml, text/xml
Sample:
<CreateSuperApiKeyArgs xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Netoptions.BizWizard.Api.Common.Models.ApiKey"> <Description>sample string 1</Description> <IsEnabled>true</IsEnabled> </CreateSuperApiKeyArgs>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
An SuperApiKeyModel of the created API key.
SuperApiKeyModelName | Description | Type | Additional information |
---|---|---|---|
Id |
The Id of the API key |
integer |
None. |
ApiKey |
The secret key value |
string |
None. |
Description |
A description of the api key usage |
string |
None. |
IsEnabled |
Can the api key be used for API requests |
boolean |
None. |
Response Formats
application/json, text/json
Sample:
{ "Id": 1, "ApiKey": "sample string 2", "Description": "sample string 3", "IsEnabled": true }
application/xml, text/xml
Sample:
<SuperApiKeyModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Netoptions.BizWizard.Api.Common.Models.ApiKey"> <ApiKey>sample string 2</ApiKey> <Description>sample string 3</Description> <Id>1</Id> <IsEnabled>true</IsEnabled> </SuperApiKeyModel>