Skip to main content
GET
/
api
/
{serviceId}
/
hsk
/
get
/
list
Typescript (SDK)
import { Authlete } from "@authlete/typescript-sdk";

const authlete = new Authlete({
  bearer: process.env["AUTHLETE_BEARER"] ?? "",
});

async function run() {
  const result = await authlete.hardwareSecurityKeys.list({
    serviceId: "<id>",
  });

  console.log(result);
}

run();
{
  "resultCode": "<string>",
  "resultMessage": "<string>",
  "action": "SUCCESS",
  "hsks": [
    {
      "kty": "<string>",
      "use": "<string>",
      "kid": "<string>",
      "hsmName": "<string>",
      "handle": "<string>",
      "publicKey": "<string>",
      "alg": "<string>"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Authenticate every request with a Service Access Token or Organization Token. Set the token value in the Authorization: Bearer <token> header.

Service Access Token: Scoped to a single service. Use when automating service-level configuration or runtime flows.

Organization Token: Scoped to the organization; inherits permissions across services. Use for org-wide automation or when managing multiple services programmatically.

Both token types are issued by the Authlete console or provisioning APIs.

Path Parameters

​
serviceId
string
required

A service ID.

Response

HSK list retrieved successfully

​
resultCode
string

The code which represents the result of the API call.

​
resultMessage
string

A short message which explains the result of the API call.

​
action
enum<string>

Result of the API call

Available options:
SUCCESS,
INVALID_REQUEST,
SERVER_ERROR
​
hsks
object[]

List of HSK