Api Key instances
Type Definitions
ApiKey #
Properties:
| Name | Type | Description |
|---|---|---|
sys |
Meta.Sys | System metadata |
name |
string | |
description |
string | |
toPlainObject() |
function | Returns this Api Key as a plain JS object |
- Source:
ApiKeyCollection #
Properties:
| Name | Type | Description |
|---|---|---|
total |
number | |
skip |
number | |
limit |
number | |
items |
Array.<ApiKey.ApiKey> | |
toPlainObject() |
function | Returns this Api Key collection as a plain JS object |
- Source:
Methods
(static) delete() → {Promise} #
Deletes this object on the server.
Returns:
Promise for the deletion. It contains no data, but the Promise error case should be handled.
- Type:
- Promise
- Source:
Example
apiKey.delete()
.catch(err => console.log(err))(static) update() → {Promise.<ApiKey>} #
Sends an update to the server with any changes made to the object's properties
Returns:
Object returned from the server with updated changes.
- Type:
- Promise.<ApiKey>
- Source:
Example
apiKey.name = 'New name'
apiKey.update()
.then(apiKey => console.log(apiKey.name))