• Role Store

passkeys

Operation related to Passkeys using the WebAuthn standard

get/role-store/api/v1/users/{user_id}/webauthn-credentials

List WebAuthn credentials

Get user's WebAuthn credentials

offsetint

Collection query offset

Default
0
Min
0
limitint

Maximum number of collection items to return

Default
50
sortkeystring

Sort by specific object property

Enum
  • id
  • user_id
  • credential_id
  • name
  • last_used
  • author
  • created
  • updated
  • updated_by
sortdirstring

Sort direction, asc or desc

Default
"ASC"
Enum
  • ASC
  • DESC

Responses

Response examples

Successful response

{
  "count": 123,
  "items": [
    {
      "id": "5bf77342-221c-11ee-be56-0242ac120002",
      "credential_id": "string",
      "name": "string",
      "comment": "string",
      "last_used": "2017-01-01T15:05:05Z",
      "created": "2017-01-01T15:05:05Z",
      "author": "5bf77342-221c-11ee-be56-0242ac120002",
      "updated": "2017-01-01T15:05:05Z",
      "updated_by": "eef4aefc-d64e-4c2c-aba4-4914c86ce059"
    }
  ]
}
get/role-store/api/v1/users/{user_id}/webauthn-credentials/{id}

Get a WebAuthn credential

Get user's WebAuthn credential

user_idstring

required

User ID

idstring

required

Credential UUID

Responses

Response examples

Successful response

{
  "id": "5bf77342-221c-11ee-be56-0242ac120002",
  "credential_id": "string",
  "name": "string",
  "comment": "string",
  "last_used": "2017-01-01T15:05:05Z",
  "created": "2017-01-01T15:05:05Z",
  "author": "5bf77342-221c-11ee-be56-0242ac120002",
  "updated": "2017-01-01T15:05:05Z",
  "updated_by": "eef4aefc-d64e-4c2c-aba4-4914c86ce059"
}
put/role-store/api/v1/users/{user_id}/webauthn-credentials/{id}

Update a WebAuthn credential

Update user's WebAuthn credential meta data

namestring

Credential name

commentstring

Optional comment

Responses

Request examples

{
  "name": "string",
  "comment": "string"
}

Response examples

Successful response

Empty response

delete/role-store/api/v1/users/{user_id}/webauthn-credentials/{id}

Delete a WebAuthn credential

Delete user's WebAuthn credential

user_idstring

required

User ID

idstring

required

Credential UUID

Responses

Response examples

Successful response

Empty response

Was this page helpful?