Skip to content
SkillPouchSkillPouch Docs

KDF parameters, secret-derived members and passkeys for the unlock screen

GET
/v1/account/unlock/params
curl --request GET \
  --url https://app.skillpouch.net/v1/account/unlock/params

Responses

Section titled “Responses”

200

Section titled “200”

Default Response

Media typeapplication/json
object
ok
required
boolean
data
required
object
state
required
string
Allowed values: setup_required ready
kdf_salt
required
Any of:
string
/^[A-Za-z0-9_-]*$/
kdf_params
required
Any of:
object
alg
required
string
Allowed values: argon2id
m
required
integer
>= 19456 <= 1048576
t
required
integer
>= 2 <= 10
p
required
integer
>= 1 <= 4
members
required
Array<object>
object
id
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
kind
required
string
Allowed values: password browser device recovery passkey
member_salt
required
Any of:
string
/^[A-Za-z0-9_-]*$/
passkeys
required
Array<object>
object
id
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
member_id
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
credential_id
required
string
/^[A-Za-z0-9_-]*$/
transports
required
Array<string>
label
required
string | null
created_at
required
string format: date-time
/^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$/
last_used_at
required
Any of:
string format: date-time
/^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$/
browser_trust_days
required
integer
>= -9007199254740991 <= 9007199254740991
failed_streak
required
integer
>= -9007199254740991 <= 9007199254740991
meta
required
object
request_id
required
string
next_cursor
string | null

Example 

{
  "ok": true,
  "data": {
    "state": "setup_required",
    "kdf_params": {
      "alg": "argon2id"
    },
    "members": [
      {
        "kind": "password"
      }
    ]
  }
}