Skip to content
Docs

Get an issuer

GEThttps://api.vercel.com/v1/kms/issuers/{issuerId}
Retrieve a single KMS issuer by its ID. Accepts either a team bearer token (existing path) or an OIDC token authorized by one of the issuer's policies (e.g. a connex-grant token). The OIDC path returns the issuer without policies, since a policy token only proves signing access, not management access.
Request
import { Vercel } from "@vercel/sdk";


const vercel = new Vercel({
  bearerToken: "<YOUR_BEARER_TOKEN_HERE>",
});


async function run() {
  const result = await vercel.kms.getKmsIssuer({
    issuerId: "<id>",
    teamId: "team_1a2b3c4d5e6f7g8h9i0j1k2l",
    slug: "my-team-url-slug",
  });


  console.log(result);
}


run();
Response
{
  "algorithm": "ES256",
  "claimsSchema": "value",
  "createdAt": "string",
  "id": "icfg_1234567890",
  "managedBy": "string",
  "name": "Example Name",
  "origin": "external",
  "ownerId": "example_id",
  "policies": [
    {
      "createdAt": "string",
      "environments": [],
      "kind": "project-grant",
      "projectId": "example_id",
      "teamId": "example_id",
      "tokenClaims": "value",
      "updatedAt": "string"
    }
  ],
  "signingKeys": [
    {
      "activateAt": "string",
      "activatedAt": "string",
      "algorithm": "string",
      "certificatePem": "string",
      "createdAt": "string",
      "importKeyId": "example_id",
      "issuerId": "example_id",
      "keyId": "example_id",
      "publicKey": {
        "alg": "string",
        "key_ops": [],
        "kid": "example_id",
        "kty": "string",
        "use": "string",
        "x5c": [],
        "x5t#S256": "string"
      },
      "publicKeyFingerprint": "string",
      "publicKeyPem": "string",
      "revokeAt": "string",
      "status": "active",
      "updatedAt": "string"
    }
  ],
  "updatedAt": "string"
}

Authentication

AuthorizationbearerToken

Default authentication mechanism

Path parameters

issuerIdstringRequired
The ID of the issuer.

Query parameters

teamIdstringOptional
The Team identifier to perform the request on behalf of.
slugstringOptional
The Team slug to perform the request on behalf of.

Response

200Success
algorithmstringRequired
claimsSchemaobjectOptional
createdAtstringRequired
idstringRequired
managedBystringOptional
namestringRequired
originstringRequired
ownerIdstringRequired
policiesarrayRequired
signingKeysarrayRequired
updatedAtstringRequired

Errors

400One of the provided values in the request query is invalid.
401The request is not authorized.
403You do not have permission to access this resource.
404Error
410Error