Skip to content

Latest commit

 

History

History
71 lines (51 loc) · 2.26 KB

index.md

File metadata and controls

71 lines (51 loc) · 2.26 KB
Raw
code type title description
true
page
createApiKey
Creates a new API key for a user

createApiKey

Creates a new API key for a user.


createApiKey(userId, description, [options]);

Property Type Description
userId 
string
 User kuid
description 
string
 API key description
options 
object
 Additional options

options

Additional query options

Property Type
(default)		 Description
expiresIn 
string/number

(-1)		 Expiration duration
_id 
string

(null)		 API key unique ID
refresh 
boolean

(false)		 If set to wait_for, Kuzzle will not respond until the API key is indexed

Notes:

  • expiresIn:
    • if a raw number is provided (not enclosed between quotes), then the expiration delay is in milliseconds. Example: 86400000
    • if this value is a string, then its content is parsed by the ms library. Examples: "6d", "10h"
    • if -1 is provided, the token will never expire

Resolves

An object containing the newly created API key:

Name Type Description
_id 
string
 ID of the newly created API key
_source 
object
 API key content

The API key content has the following properties:

Name Type Description
userId 
string
 User kuid
expiresAt 
number
 Aexpiration date in Epoch-millis format (-1 if the token never expires)
ttl 
number
 Original TTL
description 
string
 API key description
token 
string
 Authentication token associated with this API key

::: warning The authentication token token will never be returned by Kuzzle again. If you lose it, you'll have to delete the API key and recreate a new one. :::

Usage

<<< ./snippets/create-api-key.js