FusionAuth developer image
FusionAuth developer logo
  • Back to site
  • Expert Advice
  • Blog
  • Developers
  • Downloads
  • Account
  • Contact sales
Navigate to...
  • Welcome
  • Getting Started
    • Getting Started
    • 5-minute Setup Guide
      • Overview
      • Docker
      • Fast Path
      • Sandbox
    • Setup Wizard & First Login
    • Register a User and Login
    • Self-service Registration
    • Start and Stop FusionAuth
    • Core Concepts
      • Overview
      • Users
      • Roles
      • Groups
      • Registrations
      • Applications
      • Tenants
      • Identity Providers
      • Authentication/Authorization
      • Integration Points
    • Example Apps
      • Overview
      • Dart
      • Go
      • Java
      • JavaScript
      • .NET Core
      • PHP
      • Python
      • Ruby
    • Tutorials
  • Installation Guide
    • Overview
    • System Requirements
    • Server Layout
    • Cloud
    • Cluster
    • Docker
    • Fast Path
    • Kubernetes
      • Overview
      • Deployment Guide
      • Minikube Setup
      • Amazon EKS Setup
      • Google GKE Setup
      • Microsoft AKS Setup
    • Kickstart™
    • Homebrew
    • Marketplaces
    • Packages
    • Database
    • FusionAuth App
    • FusionAuth Search
    • Common Configuration
  • Migration Guide
    • Overview
    • General
    • Auth0
    • Keycloak
    • Amazon Cognito
    • Firebase
    • Microsoft Azure AD B2C
    • Tutorial
  • Admin Guide
    • Overview
    • Account Portal
    • Config Management
    • Editions and Features
    • Key Rotation
    • Licensing
    • Monitoring
    • Prometheus Setup
    • Proxy Setup
    • Reference
      • Overview
      • Configuration
      • CORS
      • Data Types
      • Hosted Login Pages Cookies
      • Known Limitations
      • Password Hashes
    • Releases
    • Roadmap
    • Search And FusionAuth
    • Securing
    • Switch Search Engines
    • Technical Support
    • Troubleshooting
    • Upgrading
    • WebAuthn
  • Login Methods
    • Identity Providers
      • Overview
      • Apple
      • Epic Games
      • External JWT
        • Overview
        • Example
      • Facebook
      • Google
      • HYPR
      • LinkedIn
      • Nintendo
      • OpenID Connect
        • Overview
        • Amazon Cognito
        • Azure AD
        • Discord
        • Github
      • Sony PlayStation Network
      • Steam
      • Twitch
      • Twitter
      • SAML v2
        • Overview
        • ADFS
        • Azure AD
      • SAML v2 IdP Initiated
        • Overview
        • Okta
      • Xbox
    • OIDC & OAuth 2.0
      • Overview
      • Endpoints
      • Tokens
      • OAuth Modes
    • Passwordless
      • Overview
      • Magic Links
      • WebAuthn & Passkeys
    • SAML v2 IdP
      • Overview
      • Google
      • Zendesk
  • Developer Guide
    • Overview
    • API Gateways
      • Overview
      • ngrok Cloud Edge
    • Client Libraries & SDKs
      • Overview
      • Dart
      • Go
      • Java
      • JavaScript
      • .NET Core
      • Node
      • OpenAPI
      • PHP
      • Python
      • React
      • Ruby
      • Typescript
    • Events & Webhooks
      • Overview
      • Writing a Webhook
      • Securing Webhooks
      • Events
        • Overview
        • Audit Log Create
        • Event Log Create
        • JWT Public Key Update
        • JWT Refresh
        • JWT Refresh Token Revoke
        • Kickstart Success
        • Group Create
        • Group Create Complete
        • Group Delete
        • Group Delete Complete
        • Group Update
        • Group Update Complete
        • Group Member Add
        • Group Member Add Complete
        • Group Member Remove
        • Group Member Remove Complete
        • Group Member Update
        • Group Member Update Complete
        • User Action
        • User Bulk Create
        • User Create
        • User Create Complete
        • User Deactivate
        • User Delete
        • User Delete Complete
        • User Email Update
        • User Email Verified
        • User IdP Link
        • User IdP Unlink
        • User Login Failed
        • User Login Id Dup. Create
        • User Login Id Dup. Update
        • User Login New Device
        • User Login Success
        • User Login Suspicious
        • User Password Breach
        • User Password Reset Send
        • User Password Reset Start
        • User Password Reset Success
        • User Password Update
        • User Reactivate
        • User Reg. Create
        • User Reg. Create Complete
        • User Reg. Delete
        • User Reg. Delete Complete
        • User Registration Update
        • User Reg. Update Complete
        • User Reg. Verified
        • User 2FA Method Add
        • User 2FA Method Remove
        • User Update
        • User Update Complete
    • Guides
      • Overview
      • Authentication Tokens
      • Exposing A Local Instance
      • JSON Web Tokens
      • Key Master
      • Localization and Internationalization
      • Multi-Factor Authentication
      • Multi-Tenant
      • Passwordless
      • Registration-based Email Verification
      • Searching With Elasticsearch
      • Securing Your APIs
      • Silent Mode
      • Single Sign-on
      • Two Factor (pre 1.26)
    • Integrations
      • Overview
      • CleanSpeak
      • Kafka
      • Twilio
    • Plugins
      • Overview
      • Writing a Plugin
      • Custom Password Hashing
    • User Control & Gating
      • Overview
      • Gate Unverified Users
      • Gate Unverified Registrations
      • User Account Lockout
  • Customization
    • Email & Templates
      • Overview
      • Configure Email
      • Email Templates
      • Email Variables
      • Message Templates
    • Lambdas
      • Overview
      • Apple Reconcile
      • Client Cred. JWT Populate
      • Epic Games Reconcile
      • External JWT Reconcile
      • Facebook Reconcile
      • Google Reconcile
      • HYPR Reconcile
      • JWT Populate
      • LDAP Connector Reconcile
      • LinkedIn Reconcile
      • Nintendo Reconcile
      • OpenID Connect Reconcile
      • SAML v2 Populate
      • SAML v2 Reconcile
      • SCIM Group Req. Converter
      • SCIM Group Resp. Convtr.
      • SCIM User Req. Converter
      • SCIM User Resp. Converter
      • Sony PSN Reconcile
      • Steam Reconcile
      • Twitch Reconcile
      • Twitter Reconcile
      • Xbox Reconcile
    • Messengers
      • Overview
      • Generic Messenger
      • Twilio Messenger
    • Themes
      • Overview
      • Examples
      • Helpers
      • Localization
      • Template Variables
  • Premium Features
    • Overview
    • Advanced Registration Forms
    • Advanced Threat Detection
    • Application Specific Themes
    • Breached Password Detection
    • Connectors
      • Overview
      • Generic Connector
      • LDAP Connector
      • FusionAuth Connector
    • Entity Management
    • SCIM
      • Overview
      • Azure AD Client
      • Okta Client
      • SCIM-SDK
    • Self Service Account Mgmt
      • Overview
      • Updating User Data & Password
      • Add Two-Factor Authenticator
      • Add Two-Factor Email
      • Add Two-Factor SMS
      • Add WebAuthn Passkey
      • Customizing
      • Troubleshooting
    • WebAuthn
  • APIs
    • Overview
    • Authentication
    • Errors
    • API Explorer
    • Actioning Users
    • API Keys
    • Applications
    • Audit Logs
    • Connectors
      • Overview
      • Generic
      • LDAP
    • Consents
    • Emails
    • Entity Management
      • Overview
      • Entities
      • Entity Types
      • Grants
    • Event Logs
    • Families
    • Forms
    • Form Fields
    • Groups
    • Identity Providers
      • Overview
      • Links
      • Apple
      • External JWT
      • Epic Games
      • Facebook
      • Google
      • HYPR
      • LinkedIn
      • Nintendo
      • OpenID Connect
      • SAML v2
      • SAML v2 IdP Initiated
      • Sony PlayStation Network
      • Steam
      • Twitch
      • Twitter
      • Xbox
    • Integrations
    • IP Access Control Lists
    • JWT
    • Keys
    • Lambdas
    • Login
    • Message Templates
    • Messengers
      • Overview
      • Generic
      • Twilio
    • Multi-Factor/Two Factor
    • Passwordless
    • Reactor
    • Registrations
    • Reports
    • SCIM
      • Overview
      • SCIM User
      • SCIM Group
      • SCIM EnterpriseUser
      • SCIM Service Provider Config.
    • System
    • Tenants
    • Themes
    • Users
    • User Actions
    • User Action Reasons
    • User Comments
    • WebAuthn
    • Webhooks
  • Release Notes

    Keys APIs

    Overview

    This API has been available since 1.6.0

    Cryptographic keys are used in signing and verifying JWTs and verifying responses for third party identity providers. It is more likely you will interact with keys using the FusionAuth UI in the Key Master menu. If you do have a need to retrieve or manage keys using the API the following APIs have been provided.

    • Retrieve a Key

    • Update a Key

    • Delete a Key

    • Generate a Key

    • Import a Key

    Retrieve a Key

    This API is used to retrieve a single Key by unique Id or all of the configured Keys.

    Request

    Retrieve all of the Keys

    URI

    GET /api/key

    Retrieve a Key by Id

    URI

    GET /api/key/{keyId}

    Request Parameters

    keyId [UUID] Required

    The unique Id of the Key to retrieve.

    Response

    The response for this API contains either a single Key or all of the Keys. When you call this API with an Id the response will contain a single Key. When you call this API without an Id the response will contain all of the Keys. Both response types are defined below along with an example JSON response.

    Table 1. Response Codes
    Code Description

    200

    The request was successful. The response will contain a JSON body.

    400

    The request was invalid and/or malformed. The response will contain an Errors JSON Object with the specific errors. This status will also be returned if a paid FusionAuth license is required and is not present.

    401

    You did not supply a valid Authorization header. The header was omitted or your API key was not valid. The response will be empty. See Authentication.

    404

    The object you requested doesn’t exist. The response will be empty.

    500

    There was an internal error. A stack trace is provided and logged in the FusionAuth log files. The response will be empty.

    503

    The search index is not available or encountered an exception so the request cannot be completed. The response will contain a JSON body.

    Response Body

    key.algorithm [String]

    The algorithm used to generate the key.

    key.certificate [String]

    The RSA or EC X.509 certificate. This field is omitted for HMAC key types.

    key.certificateInformation [Map<String, Object]

    The RSA or EC certificate information. This field is omitted for HMAC key types.

    key.certificateInformation.issuer [String]

    The issuer of the RSA or EC certificate. This field is omitted for HMAC key types.

    key.certificateInformation.md5Fingerprint [String]

    The md5 fingerprint of the RSA or EC certificate. This field is omitted for HMAC key types.

    key.certificateInformation.serialNumber [String]

    The serial number of the RSA or EC certificate. This field is omitted for HMAC key types.

    key.certificateInformation.sha1Fingerprint [String]

    The SHA-1 fingerprint of the RSA or EC certificate. This field is omitted for HMAC key types.

    key.certificateInformation.sha1Thumbprint [String]

    The SHA-1 thumbprint of the RSA or EC certificate. This field is omitted for HMAC key types.

    key.certificateInformation.sha256Fingerprint [String]

    The SHA-256 fingerprint of the RSA or EC certificate. This field is omitted for HMAC key types.

    key.certificateInformation.sha256Thumbprint [String]

    The SHA-256 thumbprint of the RSA or EC certificate. This field is omitted for HMAC key types.

    key.certificateInformation.subject [String]

    The subject of the RSA or EC certificate. This field is omitted for HMAC key types.

    key.certificateInformation.validFrom [Integer]

    The UNIX time in milliseconds marking the start of the RSA or EC certificate validity period. This field is omitted for HMAC key types.

    key.certificateInformation.validTo [Integer]

    The UNIX time in milliseconds marking the expiration RSA or EC certificate. This field is omitted for HMAC key types.

    key.expirationInstant [Integer]

    The instant marking the expiration RSA or EC certificate. This field is omitted for HMAC key types.

    key.hasPrivateKey [Boolean]

    Because the private key will never be returned in the API response, this value will indicate if the private key is stored in FusionAuth. This field is omitted for HMAC key types.

    key.id [UUID]

    The Id of the Key.

    key.insertInstant [Long]

    The instant that the key was added to the FusionAuth database.

    key.issuer [String]

    The issuer of the RSA or EC certificate. This field is omitted for HMAC key types.

    key.kid [String]

    The key identifier 'kid'.

    key.lastUpdateInstant [Long]

    The instant that the key was updated in the FusionAuth database.

    key.length [String]

    The length of the RSA or EC certificate. This field is omitted for HMAC key types.

    key.name [String]

    The name of the key.

    key.publicKey [String]

    The RSA or EC certificate public key. This field is omitted for HMAC key types.

    key.type [String]

    The key type. The possible values are:

    • EC

    • RSA

    • HMAC

    Example HMAC Key Response JSON
    
    {
      "key": {
        "algorithm": "HS256",
        "id": "092dbedc-30af-4149-9c61-b578f2c72f59",
        "insertInstant": 1562171137000,
        "kid": "10d51735a5",
        "lastUpdateInstant": 1595361143101,
        "name": "OpenID Connect compliant HMAC using SHA-256",
        "type": "HMAC"
      }
    }
    Example RSA Key Response JSON
    
    {
      "key": {
        "algorithm": "RS256",
        "certificate": "-----BEGIN CERTIFICATE-----\nMIICrjCCAZagAwIBAQIQeA4dW+47Q7KuyNuZuZrcTjANBgkqhkiG9w0BAQsFADAT\nMREwDwYDVQQDEwhhY21lLmNvbTAeFw0xOTA3MDMyMTI0MzJaFw0yOTA3MDMyMTI0\nMzJaMBMxETAPBgNVBAMTCGFjbWUuY29tMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8A\nMIIBCgKCAQEAnbNGwtU33S4vbipGeIwe/DhLEfc5FaEOHK4WeQ3QF8zZGyI09bNQ\ndkp8uNTFfVehIgmvYHmJWPeaNrYK//qjWAsSvYYoytj1j4BywI8uLSjt8QvzaoFU\nMOi1cBbXM2586R7yTRm7jMk91MLM101zkrf1cmFdRUwTpeJjw66XG3JlTGZCmZsJ\nG7m6+nbe5LHt4CiufmJHujGeFzgwby3jXZtuK1y3ua3380Fv95JyG3TucnMwEw5E\nYQ8Q+dZzNC8OSaKrgmnN0gWdsJ7P7vu6lMy6sXKhvcxo1p+tXywYPFJahxA+rZDG\n16RLbUppCx10q8tIcFKeAyl4eywzBaBLxwIDAQABMA0GCSqGSIb3DQEBCwUAA4IB\nAQBbsHWIBDwW1hFEin0D5BK/rwpCIZ4jlJ9PON4q0rF/tl9+pSzTqMeEqU0NMlJ7\nXm2O5U0i8Sy8Lhemo9qYCZ76qEiHFZwQBmNAC4de92KMcw4Q7q5CVjTGv3X+Avlg\n/c+I+zJLO/IJlzhOvHj+iCeBZDznt6/KlFfXA9EvlznxqZCQHSf2f94UlvBmqbVY\nOfXE5+OQ3URyNyh88g9yClSb4hzu1lmzevZ/AVbe2kTjZQQWB0TmqPg/6SS+nhsa\nuAMK1kSlSK9t6CPz/L7olJeAi7G/PZPaYG1gIFVFaBnYM0rwagQGtPMi1uCERCKr\nkUlBh6gSyN7SGJBvWEh6+zZF\n-----END CERTIFICATE-----",
        "certificateInformation": {
          "issuer": "CN=acme.com",
          "md5Fingerprint": "FC:36:CD:0B:9C:B7:62:F0:A9:16:AE:72:8E:F8:7D:D8",
          "serialNumber": "78:0E:1D:5B:EE:3B:43:B2:AE:C8:DB:99:B9:9A:DC:4E",
          "sha1Fingerprint": "CD:A9:80:5F:4D:37:EB:CD:B4:45:42:DF:76:35:15:E9:89:21:61:B6",
          "sha1Thumbprint": "zamAX0036820RULfdjUV6YkhYbY",
          "sha256Fingerprint": "33:7C:CB:4C:23:3B:F5:22:49:2F:68:C5:FA:D1:6E:3C:72:54:CB:3C:E6:D1:70:08:55:FC:43:24:9A:98:05:CF",
          "sha256Thumbprint": "M3zLTCM79SJJL2jF-tFuPHJUyzzm0XAIVfxDJJqYBc8",
          "subject": "CN=acme.com",
          "validFrom": 1562189072183,
          "validTo": 1877808272183
        },
        "expirationInstant": 1877808272183,
        "hasPrivateKey": false,
        "id": "780e1d5b-ee3b-43b2-aec8-db99b99adc4e",
        "insertInstant": 1562189072183,
        "issuer": "acme.com",
        "kid": "zamAX0036820RULfdjUV6YkhYbY",
        "lastUpdateInstant": 1595361143101,
        "length": 2048,
        "name": "SHA-256 with RSA",
        "publicKey": "-----BEGIN PUBLIC KEY-----\nMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAnbNGwtU33S4vbipGeIwe\n/DhLEfc5FaEOHK4WeQ3QF8zZGyI09bNQdkp8uNTFfVehIgmvYHmJWPeaNrYK//qj\nWAsSvYYoytj1j4BywI8uLSjt8QvzaoFUMOi1cBbXM2586R7yTRm7jMk91MLM101z\nkrf1cmFdRUwTpeJjw66XG3JlTGZCmZsJG7m6+nbe5LHt4CiufmJHujGeFzgwby3j\nXZtuK1y3ua3380Fv95JyG3TucnMwEw5EYQ8Q+dZzNC8OSaKrgmnN0gWdsJ7P7vu6\nlMy6sXKhvcxo1p+tXywYPFJahxA+rZDG16RLbUppCx10q8tIcFKeAyl4eywzBaBL\nxwIDAQAB\n-----END PUBLIC KEY-----",
        "type": "RSA"
      }
    }
    Example EC Key Response JSON
    
    {
      "key": {
        "algorithm": "ES256",
        "certificate": "-----BEGIN CERTIFICATE-----\nMIIBJzCBy6ADAgEBAhEAwUtQ5YaLTb6fPAKM0FFbETAMBggqhkjOPQQDAgUAMBMx\nETAPBgNVBAMTCGFjbWUuY29tMB4XDTIxMTAwMjEzNDE1MVoXDTMxMTAwMjEzNDE1\nMVowEzERMA8GA1UEAxMIYWNtZS5jb20wWTATBgcqhkjOPQIBBggqhkjOPQMBBwNC\nAARPysdu/AKSICtkZa9hlBGb7vJHJ0GHWYXEeyTYDCPd2XoT5icVAZQ5GVU1q2WV\nEaVJRmlFuGqWElvYLIRYrce2MAwGCCqGSM49BAMCBQADSQAwRgIhAJCXC5Ys25Wk\nYXeC1bWjyt71p8Yn1B//DZo+SzQrBVF+AiEA3u6an0m+wsO1dnNN1wtXdUsa5Avo\nOjME4ZLJHhtGQ1I=\n-----END CERTIFICATE-----",
        "certificateInformation": {
          "issuer": "CN=acme.com",
          "md5Fingerprint": "E5:50:70:3A:88:56:7C:BE:CB:FA:50:29:19:B5:CE:2D",
          "serialNumber": "00:C1:4B:50:E5:86:8B:4D:BE:9F:3C:02:8C:D0:51:5B:11",
          "sha1Fingerprint": "2F:22:15:AC:7C:2A:67:E8:F3:AB:87:97:3A:E0:84:58:79:A3:35:7F",
          "sha1Thumbprint": "LyIVrHwqZ-jzq4eXOuCEWHmjNX8",
          "sha256Fingerprint": "D5:B0:B5:5E:07:1D:2B:84:A8:7C:5F:89:B7:74:62:2F:8C:57:A8:66:A1:D5:A2:F1:A9:94:70:8F:D3:0D:64:0F",
          "sha256Thumbprint": "1bC1XgcdK4SofF-Jt3RiL4xXqGah1aLxqZRwj9MNZA8",
          "subject": "CN=acme.com",
          "validFrom": 1633182111000,
          "validTo": 1948714911000
        },
        "expirationInstant": 1948714911000,
        "hasPrivateKey": true,
        "id": "c14b50e5-868b-4dbe-9f3c-028cd0515b11",
        "insertInstant": 1633182111648,
        "issuer": "acme.com",
        "kid": "LyIVrHwqZ-jzq4eXOuCEWHmjNX8",
        "lastUpdateInstant": 1633182111648,
        "length": 256,
        "name": "ECDSA using P-256 curve and SHA-256",
        "publicKey": "-----BEGIN PUBLIC KEY-----\nMFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAET8rHbvwCkiArZGWvYZQRm+7yRydB\nh1mFxHsk2Awj3dl6E+YnFQGUORlVNatllRGlSUZpRbhqlhJb2CyEWK3Htg==\n-----END PUBLIC KEY-----",
        "type": "EC"
      }
    }

    Response Body

    keys[x]s [Array]

    The list of Key objects.

    keys[x].algorithm [String]

    The algorithm used to generate the key.

    keys[x].certificate [String]

    The RSA or EC X.509 certificate. This field is omitted for HMAC key types.

    keys[x].certificateInformation [Map<String, Object]

    The RSA or EC certificate information. This field is omitted for HMAC key types.

    keys[x].certificateInformation.issuer [String]

    The issuer of the RSA or EC certificate. This field is omitted for HMAC key types.

    keys[x].certificateInformation.md5Fingerprint [String]

    The md5 fingerprint of the RSA or EC certificate. This field is omitted for HMAC key types.

    keys[x].certificateInformation.serialNumber [String]

    The serial number of the RSA or EC certificate. This field is omitted for HMAC key types.

    keys[x].certificateInformation.sha1Fingerprint [String]

    The SHA-1 fingerprint of the RSA or EC certificate. This field is omitted for HMAC key types.

    keys[x].certificateInformation.sha1Thumbprint [String]

    The SHA-1 thumbprint of the RSA or EC certificate. This field is omitted for HMAC key types.

    keys[x].certificateInformation.sha256Fingerprint [String]

    The SHA-256 fingerprint of the RSA or EC certificate. This field is omitted for HMAC key types.

    keys[x].certificateInformation.sha256Thumbprint [String]

    The SHA-256 thumbprint of the RSA or EC certificate. This field is omitted for HMAC key types.

    keys[x].certificateInformation.subject [String]

    The subject of the RSA or EC certificate. This field is omitted for HMAC key types.

    keys[x].certificateInformation.validFrom [Integer]

    The UNIX time in milliseconds marking the start of the RSA or EC certificate validity period. This field is omitted for HMAC key types.

    keys[x].certificateInformation.validTo [Integer]

    The UNIX time in milliseconds marking the expiration RSA or EC certificate. This field is omitted for HMAC key types.

    keys[x].expirationInstant [Integer]

    The instant marking the expiration RSA or EC certificate. This field is omitted for HMAC key types.

    keys[x].hasPrivateKey [Boolean]

    Because the private key will never be returned in the API response, this value will indicate if the private key is stored in FusionAuth. This field is omitted for HMAC key types.

    keys[x].id [UUID]

    The Id of the Key.

    keys[x].insertInstant [Long]

    The instant that the key was added to the FusionAuth database.

    keys[x].issuer [String]

    The issuer of the RSA or EC certificate. This field is omitted for HMAC key types.

    keys[x].kid [String]

    The key identifier 'kid'.

    keys[x].lastUpdateInstant [Long]

    The instant that the key was updated in the FusionAuth database.

    keys[x].length [String]

    The length of the RSA or EC certificate. This field is omitted for HMAC key types.

    keys[x].name [String]

    The name of the key.

    keys[x].publicKey [String]

    The RSA or EC certificate public key. This field is omitted for HMAC key types.

    keys[x].type [String]

    The key type. The possible values are:

    • EC

    • RSA

    • HMAC

    Example Response JSON
    
    {
      "keys": [
        {
          "algorithm": "RS256",
          "certificate": "-----BEGIN CERTIFICATE-----\nMIICrjCCAZagAwIBAQIQeA4dW+47Q7KuyNuZuZrcTjANBgkqhkiG9w0BAQsFADAT\nMREwDwYDVQQDEwhhY21lLmNvbTAeFw0xOTA3MDMyMTI0MzJaFw0yOTA3MDMyMTI0\nMzJaMBMxETAPBgNVBAMTCGFjbWUuY29tMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8A\nMIIBCgKCAQEAnbNGwtU33S4vbipGeIwe/DhLEfc5FaEOHK4WeQ3QF8zZGyI09bNQ\ndkp8uNTFfVehIgmvYHmJWPeaNrYK//qjWAsSvYYoytj1j4BywI8uLSjt8QvzaoFU\nMOi1cBbXM2586R7yTRm7jMk91MLM101zkrf1cmFdRUwTpeJjw66XG3JlTGZCmZsJ\nG7m6+nbe5LHt4CiufmJHujGeFzgwby3jXZtuK1y3ua3380Fv95JyG3TucnMwEw5E\nYQ8Q+dZzNC8OSaKrgmnN0gWdsJ7P7vu6lMy6sXKhvcxo1p+tXywYPFJahxA+rZDG\n16RLbUppCx10q8tIcFKeAyl4eywzBaBLxwIDAQABMA0GCSqGSIb3DQEBCwUAA4IB\nAQBbsHWIBDwW1hFEin0D5BK/rwpCIZ4jlJ9PON4q0rF/tl9+pSzTqMeEqU0NMlJ7\nXm2O5U0i8Sy8Lhemo9qYCZ76qEiHFZwQBmNAC4de92KMcw4Q7q5CVjTGv3X+Avlg\n/c+I+zJLO/IJlzhOvHj+iCeBZDznt6/KlFfXA9EvlznxqZCQHSf2f94UlvBmqbVY\nOfXE5+OQ3URyNyh88g9yClSb4hzu1lmzevZ/AVbe2kTjZQQWB0TmqPg/6SS+nhsa\nuAMK1kSlSK9t6CPz/L7olJeAi7G/PZPaYG1gIFVFaBnYM0rwagQGtPMi1uCERCKr\nkUlBh6gSyN7SGJBvWEh6+zZF\n-----END CERTIFICATE-----",
          "certificateInformation": {
            "issuer": "CN=acme.com",
            "md5Fingerprint": "FC:36:CD:0B:9C:B7:62:F0:A9:16:AE:72:8E:F8:7D:D8",
            "serialNumber": "78:0E:1D:5B:EE:3B:43:B2:AE:C8:DB:99:B9:9A:DC:4E",
            "sha1Fingerprint": "CD:A9:80:5F:4D:37:EB:CD:B4:45:42:DF:76:35:15:E9:89:21:61:B6",
            "sha1Thumbprint": "zamAX0036820RULfdjUV6YkhYbY",
            "sha256Fingerprint": "33:7C:CB:4C:23:3B:F5:22:49:2F:68:C5:FA:D1:6E:3C:72:54:CB:3C:E6:D1:70:08:55:FC:43:24:9A:98:05:CF",
            "sha256Thumbprint": "M3zLTCM79SJJL2jF-tFuPHJUyzzm0XAIVfxDJJqYBc8",
            "subject": "CN=acme.com",
            "validFrom": 1562189072183,
            "validTo": 1877808272183
          },
          "expirationInstant": 1877808272183,
          "hasPrivateKey": false,
          "id": "780e1d5b-ee3b-43b2-aec8-db99b99adc4e",
          "insertInstant": 1562189072183,
          "issuer": "acme.com",
          "kid": "zamAX0036820RULfdjUV6YkhYbY",
          "lastUpdateInstant": 1595361143101,
          "length": 2048,
          "name": "SHA-256 with RSA",
          "publicKey": "-----BEGIN PUBLIC KEY-----\nMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAnbNGwtU33S4vbipGeIwe\n/DhLEfc5FaEOHK4WeQ3QF8zZGyI09bNQdkp8uNTFfVehIgmvYHmJWPeaNrYK//qj\nWAsSvYYoytj1j4BywI8uLSjt8QvzaoFUMOi1cBbXM2586R7yTRm7jMk91MLM101z\nkrf1cmFdRUwTpeJjw66XG3JlTGZCmZsJG7m6+nbe5LHt4CiufmJHujGeFzgwby3j\nXZtuK1y3ua3380Fv95JyG3TucnMwEw5EYQ8Q+dZzNC8OSaKrgmnN0gWdsJ7P7vu6\nlMy6sXKhvcxo1p+tXywYPFJahxA+rZDG16RLbUppCx10q8tIcFKeAyl4eywzBaBL\nxwIDAQAB\n-----END PUBLIC KEY-----",
          "type": "RSA"
        }
      ]
    }

    Update a Key

    This API method is used to update an existing Key.

    Only the name of the Key may be changed; all other fields will remain the same. If you need to update a Key with a new certificate, algorithm or other attributes, please Import a Key.

    For example, if you have a Key with an associated expiring certificate, you’ll need to follow the steps similar to those outlined in the JWT signing key rotation documentation:

    • Import this key, keypair or certificate into FusionAuth. This will create a new Key entity in FusionAuth.

    • Update the appropriate configuration with this new Key (JWT signing configuration, SAML validation configuration, etc).

    • Once the new Key is configured for use, remove the expired, previous Key.

    Note that validation rules will prevent you from removing an in-use key.

    Update the Key with the given Id

    URI

    PUT /api/key/{keyId}

    Request Parameters

    keyId [UUID] Required

    The unique Id of the Key to update.

    Request Body

    key.name [String] Required

    The name of the Key. It must be unique among all Keys.

    Example Request JSON
    
    {
      "key": {
        "name": "OpenID Connect compliant HMAC using SHA-256"
      }
    }

    Response

    The response for this API contains the Key that was updated.

    Table 2. Response Codes
    Code Description

    200

    The request was successful. The response will contain a JSON body.

    400

    The request was invalid and/or malformed. The response will contain an Errors JSON Object with the specific errors. This status will also be returned if a paid FusionAuth license is required and is not present.

    401

    You did not supply a valid Authorization header. The header was omitted or your API key was not valid. The response will be empty. See Authentication.

    404

    The object you are trying to update doesn’t exist. The response will be empty.

    500

    There was an internal error. A stack trace is provided and logged in the FusionAuth log files. The response will be empty.

    503

    The search index is not available or encountered an exception so the request cannot be completed. The response will contain a JSON body.

    Response Body

    key.algorithm [String]

    The algorithm used to generate the key.

    key.certificate [String]

    The RSA or EC X.509 certificate. This field is omitted for HMAC key types.

    key.certificateInformation [Map<String, Object]

    The RSA or EC certificate information. This field is omitted for HMAC key types.

    key.certificateInformation.issuer [String]

    The issuer of the RSA or EC certificate. This field is omitted for HMAC key types.

    key.certificateInformation.md5Fingerprint [String]

    The md5 fingerprint of the RSA or EC certificate. This field is omitted for HMAC key types.

    key.certificateInformation.serialNumber [String]

    The serial number of the RSA or EC certificate. This field is omitted for HMAC key types.

    key.certificateInformation.sha1Fingerprint [String]

    The SHA-1 fingerprint of the RSA or EC certificate. This field is omitted for HMAC key types.

    key.certificateInformation.sha1Thumbprint [String]

    The SHA-1 thumbprint of the RSA or EC certificate. This field is omitted for HMAC key types.

    key.certificateInformation.sha256Fingerprint [String]

    The SHA-256 fingerprint of the RSA or EC certificate. This field is omitted for HMAC key types.

    key.certificateInformation.sha256Thumbprint [String]

    The SHA-256 thumbprint of the RSA or EC certificate. This field is omitted for HMAC key types.

    key.certificateInformation.subject [String]

    The subject of the RSA or EC certificate. This field is omitted for HMAC key types.

    key.certificateInformation.validFrom [Integer]

    The UNIX time in milliseconds marking the start of the RSA or EC certificate validity period. This field is omitted for HMAC key types.

    key.certificateInformation.validTo [Integer]

    The UNIX time in milliseconds marking the expiration RSA or EC certificate. This field is omitted for HMAC key types.

    key.expirationInstant [Integer]

    The instant marking the expiration RSA or EC certificate. This field is omitted for HMAC key types.

    key.hasPrivateKey [Boolean]

    Because the private key will never be returned in the API response, this value will indicate if the private key is stored in FusionAuth. This field is omitted for HMAC key types.

    key.id [UUID]

    The Id of the Key.

    key.insertInstant [Long]

    The instant that the key was added to the FusionAuth database.

    key.issuer [String]

    The issuer of the RSA or EC certificate. This field is omitted for HMAC key types.

    key.kid [String]

    The key identifier 'kid'.

    key.lastUpdateInstant [Long]

    The instant that the key was updated in the FusionAuth database.

    key.length [String]

    The length of the RSA or EC certificate. This field is omitted for HMAC key types.

    key.name [String]

    The name of the key.

    key.publicKey [String]

    The RSA or EC certificate public key. This field is omitted for HMAC key types.

    key.type [String]

    The key type. The possible values are:

    • EC

    • RSA

    • HMAC

    Example HMAC Key Response JSON
    
    {
      "key": {
        "algorithm": "HS256",
        "id": "092dbedc-30af-4149-9c61-b578f2c72f59",
        "insertInstant": 1562171137000,
        "kid": "10d51735a5",
        "lastUpdateInstant": 1595361143101,
        "name": "OpenID Connect compliant HMAC using SHA-256",
        "type": "HMAC"
      }
    }
    Example RSA Key Response JSON
    
    {
      "key": {
        "algorithm": "RS256",
        "certificate": "-----BEGIN CERTIFICATE-----\nMIICrjCCAZagAwIBAQIQeA4dW+47Q7KuyNuZuZrcTjANBgkqhkiG9w0BAQsFADAT\nMREwDwYDVQQDEwhhY21lLmNvbTAeFw0xOTA3MDMyMTI0MzJaFw0yOTA3MDMyMTI0\nMzJaMBMxETAPBgNVBAMTCGFjbWUuY29tMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8A\nMIIBCgKCAQEAnbNGwtU33S4vbipGeIwe/DhLEfc5FaEOHK4WeQ3QF8zZGyI09bNQ\ndkp8uNTFfVehIgmvYHmJWPeaNrYK//qjWAsSvYYoytj1j4BywI8uLSjt8QvzaoFU\nMOi1cBbXM2586R7yTRm7jMk91MLM101zkrf1cmFdRUwTpeJjw66XG3JlTGZCmZsJ\nG7m6+nbe5LHt4CiufmJHujGeFzgwby3jXZtuK1y3ua3380Fv95JyG3TucnMwEw5E\nYQ8Q+dZzNC8OSaKrgmnN0gWdsJ7P7vu6lMy6sXKhvcxo1p+tXywYPFJahxA+rZDG\n16RLbUppCx10q8tIcFKeAyl4eywzBaBLxwIDAQABMA0GCSqGSIb3DQEBCwUAA4IB\nAQBbsHWIBDwW1hFEin0D5BK/rwpCIZ4jlJ9PON4q0rF/tl9+pSzTqMeEqU0NMlJ7\nXm2O5U0i8Sy8Lhemo9qYCZ76qEiHFZwQBmNAC4de92KMcw4Q7q5CVjTGv3X+Avlg\n/c+I+zJLO/IJlzhOvHj+iCeBZDznt6/KlFfXA9EvlznxqZCQHSf2f94UlvBmqbVY\nOfXE5+OQ3URyNyh88g9yClSb4hzu1lmzevZ/AVbe2kTjZQQWB0TmqPg/6SS+nhsa\nuAMK1kSlSK9t6CPz/L7olJeAi7G/PZPaYG1gIFVFaBnYM0rwagQGtPMi1uCERCKr\nkUlBh6gSyN7SGJBvWEh6+zZF\n-----END CERTIFICATE-----",
        "certificateInformation": {
          "issuer": "CN=acme.com",
          "md5Fingerprint": "FC:36:CD:0B:9C:B7:62:F0:A9:16:AE:72:8E:F8:7D:D8",
          "serialNumber": "78:0E:1D:5B:EE:3B:43:B2:AE:C8:DB:99:B9:9A:DC:4E",
          "sha1Fingerprint": "CD:A9:80:5F:4D:37:EB:CD:B4:45:42:DF:76:35:15:E9:89:21:61:B6",
          "sha1Thumbprint": "zamAX0036820RULfdjUV6YkhYbY",
          "sha256Fingerprint": "33:7C:CB:4C:23:3B:F5:22:49:2F:68:C5:FA:D1:6E:3C:72:54:CB:3C:E6:D1:70:08:55:FC:43:24:9A:98:05:CF",
          "sha256Thumbprint": "M3zLTCM79SJJL2jF-tFuPHJUyzzm0XAIVfxDJJqYBc8",
          "subject": "CN=acme.com",
          "validFrom": 1562189072183,
          "validTo": 1877808272183
        },
        "expirationInstant": 1877808272183,
        "hasPrivateKey": false,
        "id": "780e1d5b-ee3b-43b2-aec8-db99b99adc4e",
        "insertInstant": 1562189072183,
        "issuer": "acme.com",
        "kid": "zamAX0036820RULfdjUV6YkhYbY",
        "lastUpdateInstant": 1595361143101,
        "length": 2048,
        "name": "SHA-256 with RSA",
        "publicKey": "-----BEGIN PUBLIC KEY-----\nMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAnbNGwtU33S4vbipGeIwe\n/DhLEfc5FaEOHK4WeQ3QF8zZGyI09bNQdkp8uNTFfVehIgmvYHmJWPeaNrYK//qj\nWAsSvYYoytj1j4BywI8uLSjt8QvzaoFUMOi1cBbXM2586R7yTRm7jMk91MLM101z\nkrf1cmFdRUwTpeJjw66XG3JlTGZCmZsJG7m6+nbe5LHt4CiufmJHujGeFzgwby3j\nXZtuK1y3ua3380Fv95JyG3TucnMwEw5EYQ8Q+dZzNC8OSaKrgmnN0gWdsJ7P7vu6\nlMy6sXKhvcxo1p+tXywYPFJahxA+rZDG16RLbUppCx10q8tIcFKeAyl4eywzBaBL\nxwIDAQAB\n-----END PUBLIC KEY-----",
        "type": "RSA"
      }
    }
    Example EC Key Response JSON
    
    {
      "key": {
        "algorithm": "ES256",
        "certificate": "-----BEGIN CERTIFICATE-----\nMIIBJzCBy6ADAgEBAhEAwUtQ5YaLTb6fPAKM0FFbETAMBggqhkjOPQQDAgUAMBMx\nETAPBgNVBAMTCGFjbWUuY29tMB4XDTIxMTAwMjEzNDE1MVoXDTMxMTAwMjEzNDE1\nMVowEzERMA8GA1UEAxMIYWNtZS5jb20wWTATBgcqhkjOPQIBBggqhkjOPQMBBwNC\nAARPysdu/AKSICtkZa9hlBGb7vJHJ0GHWYXEeyTYDCPd2XoT5icVAZQ5GVU1q2WV\nEaVJRmlFuGqWElvYLIRYrce2MAwGCCqGSM49BAMCBQADSQAwRgIhAJCXC5Ys25Wk\nYXeC1bWjyt71p8Yn1B//DZo+SzQrBVF+AiEA3u6an0m+wsO1dnNN1wtXdUsa5Avo\nOjME4ZLJHhtGQ1I=\n-----END CERTIFICATE-----",
        "certificateInformation": {
          "issuer": "CN=acme.com",
          "md5Fingerprint": "E5:50:70:3A:88:56:7C:BE:CB:FA:50:29:19:B5:CE:2D",
          "serialNumber": "00:C1:4B:50:E5:86:8B:4D:BE:9F:3C:02:8C:D0:51:5B:11",
          "sha1Fingerprint": "2F:22:15:AC:7C:2A:67:E8:F3:AB:87:97:3A:E0:84:58:79:A3:35:7F",
          "sha1Thumbprint": "LyIVrHwqZ-jzq4eXOuCEWHmjNX8",
          "sha256Fingerprint": "D5:B0:B5:5E:07:1D:2B:84:A8:7C:5F:89:B7:74:62:2F:8C:57:A8:66:A1:D5:A2:F1:A9:94:70:8F:D3:0D:64:0F",
          "sha256Thumbprint": "1bC1XgcdK4SofF-Jt3RiL4xXqGah1aLxqZRwj9MNZA8",
          "subject": "CN=acme.com",
          "validFrom": 1633182111000,
          "validTo": 1948714911000
        },
        "expirationInstant": 1948714911000,
        "hasPrivateKey": true,
        "id": "c14b50e5-868b-4dbe-9f3c-028cd0515b11",
        "insertInstant": 1633182111648,
        "issuer": "acme.com",
        "kid": "LyIVrHwqZ-jzq4eXOuCEWHmjNX8",
        "lastUpdateInstant": 1633182111648,
        "length": 256,
        "name": "ECDSA using P-256 curve and SHA-256",
        "publicKey": "-----BEGIN PUBLIC KEY-----\nMFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAET8rHbvwCkiArZGWvYZQRm+7yRydB\nh1mFxHsk2Awj3dl6E+YnFQGUORlVNatllRGlSUZpRbhqlhJb2CyEWK3Htg==\n-----END PUBLIC KEY-----",
        "type": "EC"
      }
    }

    Delete a Key

    This API is used to delete a Key.

    Delete the Key with the given Id

    URI

    DELETE /api/key/{keyId}

    Request Parameters

    keyId [UUID] Required

    The unique Id of the Key to delete.

    Response

    This API does not return a JSON response body.

    Table 3. Response Codes
    Code Description

    200

    The request was successful. The response will be empty.

    400

    The request was invalid and/or malformed. The response will contain an Errors JSON Object with the specific errors. This status will also be returned if a paid FusionAuth license is required and is not present.

    401

    You did not supply a valid Authorization header. The header was omitted or your API key was not valid. The response will be empty. See Authentication.

    404

    The object you are trying to delete doesn’t exist. The response will be empty.

    500

    There was an internal error. A stack trace is provided and logged in the FusionAuth log files. The response will be empty.

    503

    The search index is not available or encountered an exception so the request cannot be completed. The response will contain a JSON body.

    Generate a Key

    This API is used to generate a new Key.

    Generate a new Key with a randomly generated Id

    URI

    POST /api/key/generate

    Generate a new Key with the provided unique Id

    URI

    POST /api/key/generate/{keyId}

    Request Parameters

    keyId [UUID] Optional defaults to secure random UUID

    The Id to use for the new key. If not specified a secure random UUID will be generated.

    Request Body

    key.algorithm [String] Required

    The algorithm used to generate the Key. The following values represent algorithms supported by FusionAuth:

    • ES256 - ECDSA using P-256 curve and SHA-256 hash algorithm

    • ES384 - ECDSA using P-384 curve and SHA-384 hash algorithm

    • ES512 - ECDSA using P-521 curve and SHA-512 hash algorithm

    • RS256 - RSA using SHA-256 hash algorithm

    • RS384 - RSA using SHA-384 hash algorithm

    • RS512 - RSA using SHA-512 hash algorithm

    • HS256 - HMAC using SHA-256 hash algorithm

    • HS384 - HMAC using SHA-384 hash algorithm

    • HS512 - HMAC using SHA-512 hash algorithm

    key.issuer [String] Optional defaults to [see description]

    The issuer of the RSA or EC certificate.

    If omitted, this value will default to the value of tenant.issuer on the default tenant. For HMAC keys, this field does not apply and will be ignored if specified, and no default value will be set.

    key.name [String] Required

    The name of the Key.

    key.length [String] Optional

    The length of the RSA or EC certificate. This field is required when generating RSA key types.

    For RSA, possible values are: 2048, 3072 or 4096.

    For EC, possible values are: 256, 384, or 521.

    Example Request JSON
    
    {
      "key": {
        "algorithm": "RS256",
        "issuer": "piedpiper.com",
        "name": "SHA-256 with RSA",
        "length": 2048
      }
    }

    Response

    The response for this API contains the Key that was generated.

    Table 4. Response Codes
    Code Description

    200

    The request was successful. The response will contain a JSON body.

    400

    The request was invalid and/or malformed. The response will contain an Errors JSON Object with the specific errors. This status will also be returned if a paid FusionAuth license is required and is not present.

    401

    You did not supply a valid Authorization header. The header was omitted or your API key was not valid. The response will be empty. See Authentication.

    500

    There was an internal error. A stack trace is provided and logged in the FusionAuth log files. The response will be empty.

    503

    The search index is not available or encountered an exception so the request cannot be completed. The response will contain a JSON body.

    Response Body

    key.algorithm [String]

    The algorithm used to generate the key.

    key.certificate [String]

    The RSA or EC X.509 certificate. This field is omitted for HMAC key types.

    key.certificateInformation [Map<String, Object]

    The RSA or EC certificate information. This field is omitted for HMAC key types.

    key.certificateInformation.issuer [String]

    The issuer of the RSA or EC certificate. This field is omitted for HMAC key types.

    key.certificateInformation.md5Fingerprint [String]

    The md5 fingerprint of the RSA or EC certificate. This field is omitted for HMAC key types.

    key.certificateInformation.serialNumber [String]

    The serial number of the RSA or EC certificate. This field is omitted for HMAC key types.

    key.certificateInformation.sha1Fingerprint [String]

    The SHA-1 fingerprint of the RSA or EC certificate. This field is omitted for HMAC key types.

    key.certificateInformation.sha1Thumbprint [String]

    The SHA-1 thumbprint of the RSA or EC certificate. This field is omitted for HMAC key types.

    key.certificateInformation.sha256Fingerprint [String]

    The SHA-256 fingerprint of the RSA or EC certificate. This field is omitted for HMAC key types.

    key.certificateInformation.sha256Thumbprint [String]

    The SHA-256 thumbprint of the RSA or EC certificate. This field is omitted for HMAC key types.

    key.certificateInformation.subject [String]

    The subject of the RSA or EC certificate. This field is omitted for HMAC key types.

    key.certificateInformation.validFrom [Integer]

    The UNIX time in milliseconds marking the start of the RSA or EC certificate validity period. This field is omitted for HMAC key types.

    key.certificateInformation.validTo [Integer]

    The UNIX time in milliseconds marking the expiration RSA or EC certificate. This field is omitted for HMAC key types.

    key.expirationInstant [Integer]

    The instant marking the expiration RSA or EC certificate. This field is omitted for HMAC key types.

    key.hasPrivateKey [Boolean]

    Because the private key will never be returned in the API response, this value will indicate if the private key is stored in FusionAuth. This field is omitted for HMAC key types.

    key.id [UUID]

    The Id of the Key.

    key.insertInstant [Long]

    The instant that the key was added to the FusionAuth database.

    key.issuer [String]

    The issuer of the RSA or EC certificate. This field is omitted for HMAC key types.

    key.kid [String]

    The key identifier 'kid'.

    key.lastUpdateInstant [Long]

    The instant that the key was updated in the FusionAuth database.

    key.length [String]

    The length of the RSA or EC certificate. This field is omitted for HMAC key types.

    key.name [String]

    The name of the key.

    key.publicKey [String]

    The RSA or EC certificate public key. This field is omitted for HMAC key types.

    key.type [String]

    The key type. The possible values are:

    • EC

    • RSA

    • HMAC

    Example HMAC Key Response JSON
    
    {
      "key": {
        "algorithm": "HS256",
        "id": "092dbedc-30af-4149-9c61-b578f2c72f59",
        "insertInstant": 1562171137000,
        "kid": "10d51735a5",
        "lastUpdateInstant": 1595361143101,
        "name": "OpenID Connect compliant HMAC using SHA-256",
        "type": "HMAC"
      }
    }
    Example RSA Key Response JSON
    
    {
      "key": {
        "algorithm": "RS256",
        "certificate": "-----BEGIN CERTIFICATE-----\nMIICrjCCAZagAwIBAQIQeA4dW+47Q7KuyNuZuZrcTjANBgkqhkiG9w0BAQsFADAT\nMREwDwYDVQQDEwhhY21lLmNvbTAeFw0xOTA3MDMyMTI0MzJaFw0yOTA3MDMyMTI0\nMzJaMBMxETAPBgNVBAMTCGFjbWUuY29tMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8A\nMIIBCgKCAQEAnbNGwtU33S4vbipGeIwe/DhLEfc5FaEOHK4WeQ3QF8zZGyI09bNQ\ndkp8uNTFfVehIgmvYHmJWPeaNrYK//qjWAsSvYYoytj1j4BywI8uLSjt8QvzaoFU\nMOi1cBbXM2586R7yTRm7jMk91MLM101zkrf1cmFdRUwTpeJjw66XG3JlTGZCmZsJ\nG7m6+nbe5LHt4CiufmJHujGeFzgwby3jXZtuK1y3ua3380Fv95JyG3TucnMwEw5E\nYQ8Q+dZzNC8OSaKrgmnN0gWdsJ7P7vu6lMy6sXKhvcxo1p+tXywYPFJahxA+rZDG\n16RLbUppCx10q8tIcFKeAyl4eywzBaBLxwIDAQABMA0GCSqGSIb3DQEBCwUAA4IB\nAQBbsHWIBDwW1hFEin0D5BK/rwpCIZ4jlJ9PON4q0rF/tl9+pSzTqMeEqU0NMlJ7\nXm2O5U0i8Sy8Lhemo9qYCZ76qEiHFZwQBmNAC4de92KMcw4Q7q5CVjTGv3X+Avlg\n/c+I+zJLO/IJlzhOvHj+iCeBZDznt6/KlFfXA9EvlznxqZCQHSf2f94UlvBmqbVY\nOfXE5+OQ3URyNyh88g9yClSb4hzu1lmzevZ/AVbe2kTjZQQWB0TmqPg/6SS+nhsa\nuAMK1kSlSK9t6CPz/L7olJeAi7G/PZPaYG1gIFVFaBnYM0rwagQGtPMi1uCERCKr\nkUlBh6gSyN7SGJBvWEh6+zZF\n-----END CERTIFICATE-----",
        "certificateInformation": {
          "issuer": "CN=acme.com",
          "md5Fingerprint": "FC:36:CD:0B:9C:B7:62:F0:A9:16:AE:72:8E:F8:7D:D8",
          "serialNumber": "78:0E:1D:5B:EE:3B:43:B2:AE:C8:DB:99:B9:9A:DC:4E",
          "sha1Fingerprint": "CD:A9:80:5F:4D:37:EB:CD:B4:45:42:DF:76:35:15:E9:89:21:61:B6",
          "sha1Thumbprint": "zamAX0036820RULfdjUV6YkhYbY",
          "sha256Fingerprint": "33:7C:CB:4C:23:3B:F5:22:49:2F:68:C5:FA:D1:6E:3C:72:54:CB:3C:E6:D1:70:08:55:FC:43:24:9A:98:05:CF",
          "sha256Thumbprint": "M3zLTCM79SJJL2jF-tFuPHJUyzzm0XAIVfxDJJqYBc8",
          "subject": "CN=acme.com",
          "validFrom": 1562189072183,
          "validTo": 1877808272183
        },
        "expirationInstant": 1877808272183,
        "hasPrivateKey": false,
        "id": "780e1d5b-ee3b-43b2-aec8-db99b99adc4e",
        "insertInstant": 1562189072183,
        "issuer": "acme.com",
        "kid": "zamAX0036820RULfdjUV6YkhYbY",
        "lastUpdateInstant": 1595361143101,
        "length": 2048,
        "name": "SHA-256 with RSA",
        "publicKey": "-----BEGIN PUBLIC KEY-----\nMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAnbNGwtU33S4vbipGeIwe\n/DhLEfc5FaEOHK4WeQ3QF8zZGyI09bNQdkp8uNTFfVehIgmvYHmJWPeaNrYK//qj\nWAsSvYYoytj1j4BywI8uLSjt8QvzaoFUMOi1cBbXM2586R7yTRm7jMk91MLM101z\nkrf1cmFdRUwTpeJjw66XG3JlTGZCmZsJG7m6+nbe5LHt4CiufmJHujGeFzgwby3j\nXZtuK1y3ua3380Fv95JyG3TucnMwEw5EYQ8Q+dZzNC8OSaKrgmnN0gWdsJ7P7vu6\nlMy6sXKhvcxo1p+tXywYPFJahxA+rZDG16RLbUppCx10q8tIcFKeAyl4eywzBaBL\nxwIDAQAB\n-----END PUBLIC KEY-----",
        "type": "RSA"
      }
    }
    Example EC Key Response JSON
    
    {
      "key": {
        "algorithm": "ES256",
        "certificate": "-----BEGIN CERTIFICATE-----\nMIIBJzCBy6ADAgEBAhEAwUtQ5YaLTb6fPAKM0FFbETAMBggqhkjOPQQDAgUAMBMx\nETAPBgNVBAMTCGFjbWUuY29tMB4XDTIxMTAwMjEzNDE1MVoXDTMxMTAwMjEzNDE1\nMVowEzERMA8GA1UEAxMIYWNtZS5jb20wWTATBgcqhkjOPQIBBggqhkjOPQMBBwNC\nAARPysdu/AKSICtkZa9hlBGb7vJHJ0GHWYXEeyTYDCPd2XoT5icVAZQ5GVU1q2WV\nEaVJRmlFuGqWElvYLIRYrce2MAwGCCqGSM49BAMCBQADSQAwRgIhAJCXC5Ys25Wk\nYXeC1bWjyt71p8Yn1B//DZo+SzQrBVF+AiEA3u6an0m+wsO1dnNN1wtXdUsa5Avo\nOjME4ZLJHhtGQ1I=\n-----END CERTIFICATE-----",
        "certificateInformation": {
          "issuer": "CN=acme.com",
          "md5Fingerprint": "E5:50:70:3A:88:56:7C:BE:CB:FA:50:29:19:B5:CE:2D",
          "serialNumber": "00:C1:4B:50:E5:86:8B:4D:BE:9F:3C:02:8C:D0:51:5B:11",
          "sha1Fingerprint": "2F:22:15:AC:7C:2A:67:E8:F3:AB:87:97:3A:E0:84:58:79:A3:35:7F",
          "sha1Thumbprint": "LyIVrHwqZ-jzq4eXOuCEWHmjNX8",
          "sha256Fingerprint": "D5:B0:B5:5E:07:1D:2B:84:A8:7C:5F:89:B7:74:62:2F:8C:57:A8:66:A1:D5:A2:F1:A9:94:70:8F:D3:0D:64:0F",
          "sha256Thumbprint": "1bC1XgcdK4SofF-Jt3RiL4xXqGah1aLxqZRwj9MNZA8",
          "subject": "CN=acme.com",
          "validFrom": 1633182111000,
          "validTo": 1948714911000
        },
        "expirationInstant": 1948714911000,
        "hasPrivateKey": true,
        "id": "c14b50e5-868b-4dbe-9f3c-028cd0515b11",
        "insertInstant": 1633182111648,
        "issuer": "acme.com",
        "kid": "LyIVrHwqZ-jzq4eXOuCEWHmjNX8",
        "lastUpdateInstant": 1633182111648,
        "length": 256,
        "name": "ECDSA using P-256 curve and SHA-256",
        "publicKey": "-----BEGIN PUBLIC KEY-----\nMFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAET8rHbvwCkiArZGWvYZQRm+7yRydB\nh1mFxHsk2Awj3dl6E+YnFQGUORlVNatllRGlSUZpRbhqlhJb2CyEWK3Htg==\n-----END PUBLIC KEY-----",
        "type": "EC"
      }
    }

    Import a Key

    This API is used to import an existing Key into FusionAuth.

    For RSA pairs, possible key lengths are: 1024 (only valid when importing a public key for signature verification), 2048, 3072 or 4096.

    For EC pairs, possible key lengths are: 256, 384, or 521.

    Import an existing Key with a randomly generated Id

    URI

    POST /api/key/import

    Import an existing Key with the provided unique Id

    URI

    POST /api/key/import/{keyId}

    Request Parameters

    keyId [UUID] Optional

    The unique Id of the Key. Use if you want to specify a known UUID. This is useful if you are migrating from an existing system or will otherwise depend on having a known key Id.

    Request Body

    key.algorithm [String] Optional

    The algorithm used to generate the Key. The algorithm will be inferred if it is not passed explicitly. The following values represent algorithms supported by FusionAuth:

    • ES256 - ECDSA using P-256 curve and SHA-256 hash algorithm

    • ES384 - ECDSA using P-384 curve and SHA-384 hash algorithm

    • ES512 - ECDSA using P-521 curve and SHA-512 hash algorithm

    • RS256 - RSA using SHA-256 hash algorithm

    • RS384 - RSA using SHA-384 hash algorithm

    • RS512 - RSA using SHA-512 hash algorithm

    • HS256 - HMAC using SHA-256 hash algorithm

    • HS384 - HMAC using SHA-384 hash algorithm

    • HS512 - HMAC using SHA-512 hash algorithm

    key.certificate [String] Optional

    The certificate to import. The publicKey will be extracted from the certificate.

    key.kid [String] Optional

    The Key identifier 'kid'. When this value is omitted, one will be generated.

    key.name [String] Required

    The name of the Key. It must be unique among all Keys.

    key.publicKey [String] Optional

    The Key public key. Required if importing an RSA or EC key and a certificate is not provided.

    key.privateKey [String] Optional

    The Key private key. Optional if importing an RSA or EC key. If the key is only to be used for token validation, only a public key is necessary and this field may be omitted.

    key.secret [String] Optional

    The Key secret. This field is required if importing an HMAC key type.

    key.type [String] Optional

    The Key type. This field is required if importing an HMAC key type, or if importing a public key / private key pair. The possible values are:

    • EC

    • RSA

    • HMAC

    Example Request JSON
    
    {
      "key": {
        "name": "SHA-256 with RSA",
        "kid": "zamAX0036820RULfdjUV6YkhYbY",
        "certificate":"MIICrjCCAZagAwIBAQIQeA4dW+47Q7KuyNuZuZrcTjANBgkqhkiG9w0BAQsFADATMREwDwYDVQQDEwhhY21lLmNvbTAeFw0xOTA3MDMyMTI0MzJaFw0yOTA3MDMyMTI0MzJaMBMxETAPBgNVBAMTCGFjbWUuY29tMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAnbNGwtU33S4vbipGeIwe/DhLEfc5FaEOHK4WeQ3QF8zZGyI09bNQdkp8uNTFfVehIgmvYHmJWPeaNrYK//qjWAsSvYYoytj1j4BywI8uLSjt8QvzaoFUMOi1cBbXM2586R7yTRm7jMk91MLM101zkrf1cmFdRUwTpeJjw66XG3JlTGZCmZsJG7m6+nbe5LHt4CiufmJHujGeFzgwby3jXZtuK1y3ua3380Fv95JyG3TucnMwEw5EYQ8Q+dZzNC8OSaKrgmnN0gWdsJ7P7vu6lMy6sXKhvcxo1p+tXywYPFJahxA+rZDG16RLbUppCx10q8tIcFKeAyl4eywzBaBLxwIDAQABMA0GCSqGSIb3DQEBCwUAA4IBAQBbsHWIBDwW1hFEin0D5BK/rwpCIZ4jlJ9PON4q0rF/tl9+pSzTqMeEqU0NMlJ7Xm2O5U0i8Sy8Lhemo9qYCZ76qEiHFZwQBmNAC4de92KMcw4Q7q5CVjTGv3X+Avlg/c+I+zJLO/IJlzhOvHj+iCeBZDznt6/KlFfXA9EvlznxqZCQHSf2f94UlvBmqbVYOfXE5+OQ3URyNyh88g9yClSb4hzu1lmzevZ/AVbe2kTjZQQWB0TmqPg/6SS+nhsauAMK1kSlSK9t6CPz/L7olJeAi7G/PZPaYG1gIFVFaBnYM0rwagQGtPMi1uCERCKrkUlBh6gSyN7SGJBvWEh6+zZF"
      }
    }

    Response

    The response for this API contains the Key that was imported.

    Table 5. Response Codes
    Code Description

    200

    The request was successful. The response will contain a JSON body.

    400

    The request was invalid and/or malformed. The response will contain an Errors JSON Object with the specific errors. This status will also be returned if a paid FusionAuth license is required and is not present.

    401

    You did not supply a valid Authorization header. The header was omitted or your API key was not valid. The response will be empty. See Authentication.

    500

    There was an internal error. A stack trace is provided and logged in the FusionAuth log files. The response will be empty.

    503

    The search index is not available or encountered an exception so the request cannot be completed. The response will contain a JSON body.

    Response Body

    key.algorithm [String]

    The algorithm used to generate the key.

    key.certificate [String]

    The RSA or EC X.509 certificate. This field is omitted for HMAC key types.

    key.certificateInformation [Map<String, Object]

    The RSA or EC certificate information. This field is omitted for HMAC key types.

    key.certificateInformation.issuer [String]

    The issuer of the RSA or EC certificate. This field is omitted for HMAC key types.

    key.certificateInformation.md5Fingerprint [String]

    The md5 fingerprint of the RSA or EC certificate. This field is omitted for HMAC key types.

    key.certificateInformation.serialNumber [String]

    The serial number of the RSA or EC certificate. This field is omitted for HMAC key types.

    key.certificateInformation.sha1Fingerprint [String]

    The SHA-1 fingerprint of the RSA or EC certificate. This field is omitted for HMAC key types.

    key.certificateInformation.sha1Thumbprint [String]

    The SHA-1 thumbprint of the RSA or EC certificate. This field is omitted for HMAC key types.

    key.certificateInformation.sha256Fingerprint [String]

    The SHA-256 fingerprint of the RSA or EC certificate. This field is omitted for HMAC key types.

    key.certificateInformation.sha256Thumbprint [String]

    The SHA-256 thumbprint of the RSA or EC certificate. This field is omitted for HMAC key types.

    key.certificateInformation.subject [String]

    The subject of the RSA or EC certificate. This field is omitted for HMAC key types.

    key.certificateInformation.validFrom [Integer]

    The UNIX time in milliseconds marking the start of the RSA or EC certificate validity period. This field is omitted for HMAC key types.

    key.certificateInformation.validTo [Integer]

    The UNIX time in milliseconds marking the expiration RSA or EC certificate. This field is omitted for HMAC key types.

    key.expirationInstant [Integer]

    The instant marking the expiration RSA or EC certificate. This field is omitted for HMAC key types.

    key.hasPrivateKey [Boolean]

    Because the private key will never be returned in the API response, this value will indicate if the private key is stored in FusionAuth. This field is omitted for HMAC key types.

    key.id [UUID]

    The Id of the Key.

    key.insertInstant [Long]

    The instant that the key was added to the FusionAuth database.

    key.issuer [String]

    The issuer of the RSA or EC certificate. This field is omitted for HMAC key types.

    key.kid [String]

    The key identifier 'kid'.

    key.lastUpdateInstant [Long]

    The instant that the key was updated in the FusionAuth database.

    key.length [String]

    The length of the RSA or EC certificate. This field is omitted for HMAC key types.

    key.name [String]

    The name of the key.

    key.publicKey [String]

    The RSA or EC certificate public key. This field is omitted for HMAC key types.

    key.type [String]

    The key type. The possible values are:

    • EC

    • RSA

    • HMAC

    Example HMAC Key Response JSON
    
    {
      "key": {
        "algorithm": "HS256",
        "id": "092dbedc-30af-4149-9c61-b578f2c72f59",
        "insertInstant": 1562171137000,
        "kid": "10d51735a5",
        "lastUpdateInstant": 1595361143101,
        "name": "OpenID Connect compliant HMAC using SHA-256",
        "type": "HMAC"
      }
    }
    Example RSA Key Response JSON
    
    {
      "key": {
        "algorithm": "RS256",
        "certificate": "-----BEGIN CERTIFICATE-----\nMIICrjCCAZagAwIBAQIQeA4dW+47Q7KuyNuZuZrcTjANBgkqhkiG9w0BAQsFADAT\nMREwDwYDVQQDEwhhY21lLmNvbTAeFw0xOTA3MDMyMTI0MzJaFw0yOTA3MDMyMTI0\nMzJaMBMxETAPBgNVBAMTCGFjbWUuY29tMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8A\nMIIBCgKCAQEAnbNGwtU33S4vbipGeIwe/DhLEfc5FaEOHK4WeQ3QF8zZGyI09bNQ\ndkp8uNTFfVehIgmvYHmJWPeaNrYK//qjWAsSvYYoytj1j4BywI8uLSjt8QvzaoFU\nMOi1cBbXM2586R7yTRm7jMk91MLM101zkrf1cmFdRUwTpeJjw66XG3JlTGZCmZsJ\nG7m6+nbe5LHt4CiufmJHujGeFzgwby3jXZtuK1y3ua3380Fv95JyG3TucnMwEw5E\nYQ8Q+dZzNC8OSaKrgmnN0gWdsJ7P7vu6lMy6sXKhvcxo1p+tXywYPFJahxA+rZDG\n16RLbUppCx10q8tIcFKeAyl4eywzBaBLxwIDAQABMA0GCSqGSIb3DQEBCwUAA4IB\nAQBbsHWIBDwW1hFEin0D5BK/rwpCIZ4jlJ9PON4q0rF/tl9+pSzTqMeEqU0NMlJ7\nXm2O5U0i8Sy8Lhemo9qYCZ76qEiHFZwQBmNAC4de92KMcw4Q7q5CVjTGv3X+Avlg\n/c+I+zJLO/IJlzhOvHj+iCeBZDznt6/KlFfXA9EvlznxqZCQHSf2f94UlvBmqbVY\nOfXE5+OQ3URyNyh88g9yClSb4hzu1lmzevZ/AVbe2kTjZQQWB0TmqPg/6SS+nhsa\nuAMK1kSlSK9t6CPz/L7olJeAi7G/PZPaYG1gIFVFaBnYM0rwagQGtPMi1uCERCKr\nkUlBh6gSyN7SGJBvWEh6+zZF\n-----END CERTIFICATE-----",
        "certificateInformation": {
          "issuer": "CN=acme.com",
          "md5Fingerprint": "FC:36:CD:0B:9C:B7:62:F0:A9:16:AE:72:8E:F8:7D:D8",
          "serialNumber": "78:0E:1D:5B:EE:3B:43:B2:AE:C8:DB:99:B9:9A:DC:4E",
          "sha1Fingerprint": "CD:A9:80:5F:4D:37:EB:CD:B4:45:42:DF:76:35:15:E9:89:21:61:B6",
          "sha1Thumbprint": "zamAX0036820RULfdjUV6YkhYbY",
          "sha256Fingerprint": "33:7C:CB:4C:23:3B:F5:22:49:2F:68:C5:FA:D1:6E:3C:72:54:CB:3C:E6:D1:70:08:55:FC:43:24:9A:98:05:CF",
          "sha256Thumbprint": "M3zLTCM79SJJL2jF-tFuPHJUyzzm0XAIVfxDJJqYBc8",
          "subject": "CN=acme.com",
          "validFrom": 1562189072183,
          "validTo": 1877808272183
        },
        "expirationInstant": 1877808272183,
        "hasPrivateKey": false,
        "id": "780e1d5b-ee3b-43b2-aec8-db99b99adc4e",
        "insertInstant": 1562189072183,
        "issuer": "acme.com",
        "kid": "zamAX0036820RULfdjUV6YkhYbY",
        "lastUpdateInstant": 1595361143101,
        "length": 2048,
        "name": "SHA-256 with RSA",
        "publicKey": "-----BEGIN PUBLIC KEY-----\nMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAnbNGwtU33S4vbipGeIwe\n/DhLEfc5FaEOHK4WeQ3QF8zZGyI09bNQdkp8uNTFfVehIgmvYHmJWPeaNrYK//qj\nWAsSvYYoytj1j4BywI8uLSjt8QvzaoFUMOi1cBbXM2586R7yTRm7jMk91MLM101z\nkrf1cmFdRUwTpeJjw66XG3JlTGZCmZsJG7m6+nbe5LHt4CiufmJHujGeFzgwby3j\nXZtuK1y3ua3380Fv95JyG3TucnMwEw5EYQ8Q+dZzNC8OSaKrgmnN0gWdsJ7P7vu6\nlMy6sXKhvcxo1p+tXywYPFJahxA+rZDG16RLbUppCx10q8tIcFKeAyl4eywzBaBL\nxwIDAQAB\n-----END PUBLIC KEY-----",
        "type": "RSA"
      }
    }
    Example EC Key Response JSON
    
    {
      "key": {
        "algorithm": "ES256",
        "certificate": "-----BEGIN CERTIFICATE-----\nMIIBJzCBy6ADAgEBAhEAwUtQ5YaLTb6fPAKM0FFbETAMBggqhkjOPQQDAgUAMBMx\nETAPBgNVBAMTCGFjbWUuY29tMB4XDTIxMTAwMjEzNDE1MVoXDTMxMTAwMjEzNDE1\nMVowEzERMA8GA1UEAxMIYWNtZS5jb20wWTATBgcqhkjOPQIBBggqhkjOPQMBBwNC\nAARPysdu/AKSICtkZa9hlBGb7vJHJ0GHWYXEeyTYDCPd2XoT5icVAZQ5GVU1q2WV\nEaVJRmlFuGqWElvYLIRYrce2MAwGCCqGSM49BAMCBQADSQAwRgIhAJCXC5Ys25Wk\nYXeC1bWjyt71p8Yn1B//DZo+SzQrBVF+AiEA3u6an0m+wsO1dnNN1wtXdUsa5Avo\nOjME4ZLJHhtGQ1I=\n-----END CERTIFICATE-----",
        "certificateInformation": {
          "issuer": "CN=acme.com",
          "md5Fingerprint": "E5:50:70:3A:88:56:7C:BE:CB:FA:50:29:19:B5:CE:2D",
          "serialNumber": "00:C1:4B:50:E5:86:8B:4D:BE:9F:3C:02:8C:D0:51:5B:11",
          "sha1Fingerprint": "2F:22:15:AC:7C:2A:67:E8:F3:AB:87:97:3A:E0:84:58:79:A3:35:7F",
          "sha1Thumbprint": "LyIVrHwqZ-jzq4eXOuCEWHmjNX8",
          "sha256Fingerprint": "D5:B0:B5:5E:07:1D:2B:84:A8:7C:5F:89:B7:74:62:2F:8C:57:A8:66:A1:D5:A2:F1:A9:94:70:8F:D3:0D:64:0F",
          "sha256Thumbprint": "1bC1XgcdK4SofF-Jt3RiL4xXqGah1aLxqZRwj9MNZA8",
          "subject": "CN=acme.com",
          "validFrom": 1633182111000,
          "validTo": 1948714911000
        },
        "expirationInstant": 1948714911000,
        "hasPrivateKey": true,
        "id": "c14b50e5-868b-4dbe-9f3c-028cd0515b11",
        "insertInstant": 1633182111648,
        "issuer": "acme.com",
        "kid": "LyIVrHwqZ-jzq4eXOuCEWHmjNX8",
        "lastUpdateInstant": 1633182111648,
        "length": 256,
        "name": "ECDSA using P-256 curve and SHA-256",
        "publicKey": "-----BEGIN PUBLIC KEY-----\nMFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAET8rHbvwCkiArZGWvYZQRm+7yRydB\nh1mFxHsk2Awj3dl6E+YnFQGUORlVNatllRGlSUZpRbhqlhJb2CyEWK3Htg==\n-----END PUBLIC KEY-----",
        "type": "EC"
      }
    }

    Feedback

    How helpful was this page?

    See a problem?

    File an issue in our docs repo

    Have a question or comment to share?

    Visit the FusionAuth community forum.

    © 2023 FusionAuth
    Subscribe for developer updates