Resources
🤖 For AI agents: The complete documentation index is available at /docs/llms.txt. A markdown version of this page is available at /docs/apis/keys/search-for-keys.md.

Search for Keys

Edit on GitHub
View Markdown
version

This API has been available since 1.45.0

This API is used to search for Keys and may be called using the GET or POST HTTP methods. Examples of each are provided below. The POST method is provided to allow for a richer request object without worrying about exceeding the maximum length of a URL. Calling this API with either the GET or POST HTTP method will provide the same search results given the same query parameters.

Request#

Global API Key Authentication
Search for Keys
GET/api/key/search?algorithm=RS256&name={name}&type=RSA
OpenAPI Spec

Request Parameters#

algorithm String optional

The algorithm used to generate the key.

The possible values are:

  • Ed25519 - EdDSA using the Ed25519 parameter set Available since 1.62.0
  • 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
  • None - Secret Available since 1.64.0
name String optional

The case-insensitive string to search for in the Key name. This can contain wildcards using the asterisk character (*). If no wildcards are present, the search criteria will be interpreted as *value*.

numberOfResults Integer optional Defaults to 25

The number of results to return from the search.

orderBy String optional Defaults to name ASC

The field to order the search results as well as an order direction.

The possible values are:

  • algorithm - the algorithm used to generate the Key.
    • Not all keys have an algorithm, null values are treated as smaller than all other values.
    • The possible values are: See algorithm.
  • expiration - the expiration instant of the Key.
    • Not all keys have an expiration value, null values are treated as smaller than all other values.
  • id - the UUID of the Key
  • insertInstant - the instant when the Key was created
  • name - the Key name
  • type - the Key type
    • The possible values are: See type.

The order direction is optional. Possible values of the order direction are ASC or DESC. If omitted, the default sort order is ASC.

For example, to order the results by the insert instant in a descending order, use insertInstant DESC.

startRow Integer optional Defaults to 0

The offset into the total results. In order to paginate the results, increment this value by the numberOfResults for subsequent requests.

For example, if the total search results are greater than the page size designated by numberOfResults, set this value to 25 to retrieve results 26-50, assuming the default page size.

type String optional

The key type. The possible values are:

  • EC
  • OKP Available since 1.62.0
  • RSA
  • HMAC
  • Secret Available since 1.64.0
Global API Key Authentication
Search for Keys
POST/api/key/search
OpenAPI Spec

When calling the API using a POST request you will send the search criteria in a JSON request body.

Request Body#

search.algorithm String optional

The algorithm used to generate the key.

The possible values are:

  • Ed25519 - EdDSA using the Ed25519 parameter set Available since 1.62.0
  • 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
  • None - Secret Available since 1.64.0
search.name String optional

The case-insensitive string to search for in the Key name. This can contain wildcards using the asterisk character (*). If no wildcards are present, the search criteria will be interpreted as *value*.

search.numberOfResults Integer optional Defaults to 25

The number of results to return from the search.

search.orderBy String optional Defaults to name ASC

The field to order the search results as well as an order direction.

The possible values are:

  • algorithm - the algorithm used to generate the Key.
    • Not all keys have an algorithm, null values are treated as smaller than all other values.
    • The possible values are: See search.algorithm.
  • expiration - the expiration instant of the Key.
    • Not all keys have an expiration value, null values are treated as smaller than all other values.
  • id - the UUID of the Key
  • insertInstant - the instant when the Key was created
  • name - the Key name
  • type - the Key type
    • The possible values are: See search.type.

The order direction is optional. Possible values of the order direction are ASC or DESC. If omitted, the default sort order is ASC.

For example, to order the results by the insert instant in a descending order, use insertInstant DESC.

search.startRow Integer optional Defaults to 0

The offset into the total results. In order to paginate the results, increment this value by the numberOfResults for subsequent requests.

For example, if the total search results are greater than the page size designated by numberOfResults, set this value to 25 to retrieve results 26-50, assuming the default page size.

search.type String optional

The key type. The possible values are:

  • EC
  • OKP Available since 1.62.0
  • RSA
  • HMAC
  • Secret Available since 1.64.0

Example Request JSON

{
  "search": {
    "algorithm": "RS256",
    "name": "forum",
    "numberOfResults": 25,
    "orderBy": "insertInstant",
    "startRow": 0,
    "type": "RSA"
  }
}

Response#

The response for this API contains the Keys matching the search criteria in paginated format and the total number of results matching the search criteria.

Response Codes
CodeDescription
200The request was successful. The response will contain a JSON body.
400The 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.
401You 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.
500There was an internal error. A stack trace is provided and logged in the FusionAuth log files. The response will be empty.

Response Body#

keys[x] Array

The list of Key objects.

keys[x].algorithm String

The algorithm used to generate the key. For Secrets, this value will be None.

keys[x].certificate String

The X.509 certificate. This field is omitted for HMAC keys and Secrets.

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

The RSA or EC certificate information. This field is omitted for HMAC keys and Secrets.

keys[x].certificateInformation.issuer String

The issuer of the certificate. This field is omitted for HMAC keys and Secrets.

keys[x].certificateInformation.md5Fingerprint String

The md5 fingerprint of the certificate. This field is omitted for HMAC keys and Secrets.

keys[x].certificateInformation.serialNumber String

The serial number of the certificate. This field is omitted for HMAC keys and Secrets.

keys[x].certificateInformation.sha1Fingerprint String

The SHA-1 fingerprint of the certificate. This field is omitted for HMAC keys and Secrets.

keys[x].certificateInformation.sha1Thumbprint String

The SHA-1 thumbprint of the certificate. This field is omitted for HMAC keys and Secrets.

keys[x].certificateInformation.sha256Fingerprint String

The SHA-256 fingerprint of the certificate. This field is omitted for HMAC keys and Secrets.

keys[x].certificateInformation.sha256Thumbprint String

The SHA-256 thumbprint of the certificate. This field is omitted for HMAC keys and Secrets.

keys[x].certificateInformation.subject String

The subject of the certificate. This field is omitted for HMAC keys and Secrets.

keys[x].certificateInformation.validFrom Integer

The UNIX time in milliseconds marking the start of the certificate validity period. This field is omitted for HMAC keys and Secrets.

keys[x].certificateInformation.validTo Integer

The UNIX time in milliseconds marking the expiration certificate. This field is omitted for HMAC keys and Secrets.

keys[x].expirationInstant Integer

The instant marking the expiration certificate. This field is omitted for HMAC keys and Secrets.

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 keys and Secrets.

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 certificate. This field is omitted for HMAC keys and Secrets.

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 certificate. This field is omitted for HMAC keys and Secrets.

keys[x].name String

The name of the key.

keys[x].publicKey String

The certificate public key. This field is omitted for HMAC keys and Secrets.

keys[x].type String

The key type. The possible values are:

  • EC
  • OKP Available since 1.62.0
  • RSA
  • HMAC
  • Secret Available since 1.64.0