Please enable JavaScript to view this site.

 

Valid for ApiKey Authentication Mode only.

Through an API Key, a operation is authenticated and authorized. The value pair x-api-key: "yourapikey" must be included In the body of the request.

More information on this link

Field

Type

Description

New

Button

Create an ApiKey.

Delete Selected

Button

Delete selected ApiKeys from the Database.

Export Selected

Button

Export selected ApiKeys to a JSON file.

Import from file

Button

Import ApiKeys from a JSON file.

Pencil Icon

Button

Edit the ApiKey.

Trash Icon

Button

Delete the ApiKey.

Copy Icon

Button

Create an ApiKey by copying data from an existing ApiKey.

 

Create/Edit/Copy API Key

.

Campo

Tipo

Descripción

Cancel

Button

Discard changes and close the form.

Create/Update

Button

Save the ApiKey

x-api-key

Required

ApiKey code passed in the request with the value pair x-api-key: "yourapikey".

Expiration Date

Optional

ApiKey expiration date.

Enabled

Switch

Enables/Disables the ApiKey.

Swagger Description

Optional

Description shown in the Swagger.

Internal Description

Optional

Description shown in the documentation.

Allowed IPs

Optional

Allowed source IPs or DNS to execute operations in this API Key.

You can specify IP's or IP Range separated by hyphen.

If you want to indicate a DNS you must indicate as prefix "dns"

 

Examples:

192.168.0.100

192.168.0.0-192.168.0.254

dns:mydomain.com

 

 

Each API Key will be able to execute a certain selection of defined Scopes. It is mandatory to indicate which Scopes are enabled for the API Key. From the Select Scopes select you will be able to add one or more available Scopes from one or more ApiResources.

 

 

 

 

 

 

 

by Kosday Solutions