This is the official documentation of HelioAuth Passkeys API. It provides a simple interface for user authentication with WebAuthn passkeys.
Start by creating an application at /admin/v1/apps. Then, get its API key from /admin/v1/apps/{id}/api-key.
Start sign-up
(Can be called from the browser)
Generates a challenge ready to be passed to navigator.credentials.create(options)
Request Body schema: application/jsonrequired
| name required | string Username to be registered. This can also be an identifier or an email address. |
Responses
Response Schema: application/json
| requestId | string Unique identifier for the sign-up request. |
| options | string Options to pass to |
Request samples
- Payload
{- "name": "string"
}Response samples
- 200
{- "requestId": "string",
- "options": "string"
}Complete sign-up
Completes the sign-up process by verifying the attestation and registering the new credential.
Request Body schema: application/jsonrequired
| requestId | string Unique identifier for the sign-up request (from |
| publicKeyCredential | string The result of |
Responses
Response Schema: application/json
| requestId | string Unique identifier for the sign-up request. |
| userId | string <uuid> Unique identifier for the newly registered user. |
Request samples
- Payload
{- "requestId": "string",
- "publicKeyCredential": "string"
}Response samples
- 200
{- "requestId": "string",
- "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b"
}Start sign-in
(Can be called from the browser)
Generates a challenge ready to be passed to navigator.credentials.get(options).
Request Body schema: application/jsonrequired
| name | string Name of the user attempting to sign in. |
Responses
Response Schema: application/json
| requestId | string Unique identifier for the sign-in request. |
| options | string Options for assertion to pass to |
Request samples
- Payload
{- "name": "string"
}Response samples
- 200
{- "requestId": "string",
- "options": "string"
}Complete sign-in
Validates the credential response from the client and returns the user's identifier.
Request Body schema: application/jsonrequired
| requestId | string Unique identifier for the sign-in request (returned by |
| publicKeyCredentialWithAssertion | string The result of |
Responses
Response Schema: application/json
| requestId | string Unique identifier for the sign-in request. |
| username | string Username of the entity that signed in. |
Request samples
- Payload
{- "requestId": "string",
- "publicKeyCredentialWithAssertion": "string"
}Response samples
- 200
{- "requestId": "string",
- "username": "string"
}Initiate adding a new passkey to user account
Initiates the process of adding a new passkey to a user's account.
Request Body schema: application/jsonrequired
| name required | string Username to be registered. This can also be an identifier or an email address. |
Responses
Response Schema: application/json
| requestId | string Unique identifier for the sign-up request. |
| options | string Options to pass to |
Request samples
- Payload
{- "name": "string"
}Response samples
- 200
{- "requestId": "string",
- "options": "string"
}Complete the passkey addition process
Completes the process of adding a new passkey to a user's account.
Request Body schema: application/jsonrequired
| requestId | string Unique identifier for the sign-up request (from |
| publicKeyCredential | string The result of |
Responses
Response Schema: application/json
| requestId | string Unique identifier for the sign-up request. |
| userId | string <uuid> Unique identifier for the newly registered user. |
Request samples
- Payload
{- "requestId": "string",
- "publicKeyCredential": "string"
}Response samples
- 200
{- "requestId": "string",
- "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b"
}Get user's credentials
Retrieves a list of credentials associated with a specific user by UUID.
path Parameters
| uuid required | string <uuid> |
Responses
Response Schema: application/json
Array of objects (PasskeyCredential) A list of user credentials. |
Response samples
- 200
{- "passkeys": [
- {
- "credentialId": "string",
- "userHandle": "string",
- "signatureCount": 0,
- "displayName": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "lastUsedAt": "2019-08-24T14:15:22Z"
}
]
}List all applications
Retrieves a list of all applications.
Authorizations:
Responses
Response Schema: application/json
| id | string <uuid> Unique identifier for the application. |
| name | string Name of the application. |
| createdAt | string <date-time> Timestamp when the application was created. |
| updatedAt | string <date-time> Timestamp when the application was last updated. |
Response samples
- 200
[- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}
]Add a new application
Creates a new application and returns its details.
Authorizations:
Request Body schema: application/jsonrequired
| name | string Name of the new application. |
Responses
Response Schema: application/json
| id | string <uuid> Unique identifier for the application. |
| name | string Name of the application. |
| createdAt | string <date-time> Timestamp when the application was created. |
| updatedAt | string <date-time> Timestamp when the application was last updated. |
Request samples
- Payload
{- "name": "string"
}Response samples
- 201
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}Get an application
Retrieves details of a specific application by its ID.
Authorizations:
path Parameters
| id required | string <uuid> |
Responses
Response Schema: application/json
| id | string <uuid> Unique identifier for the application. |
| name | string Name of the application. |
| createdAt | string <date-time> Timestamp when the application was created. |
| updatedAt | string <date-time> Timestamp when the application was last updated. |
Response samples
- 200
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}Edit an application
Updates the name of a specific application by its ID.
Authorizations:
path Parameters
| id required | string <uuid> |
Request Body schema: application/jsonrequired
Responses
Response Schema: application/json
| id | string <uuid> Unique identifier for the application. |
| name | string Name of the application. |
| createdAt | string <date-time> Timestamp when the application was created. |
| updatedAt | string <date-time> Timestamp when the application was last updated. |
Request samples
- Payload
"string"Response samples
- 200
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}Get an application's API key
Retrieves the API key of a specific application by its ID.
Authorizations:
path Parameters
| id required | string <uuid> |
Responses
Response Schema: application/json
| apiKey | string API key for the client application. |
Response samples
- 200
{- "apiKey": "string"
}