Ana içeriğe atla

​
Endpoint

GET /apiops/projects/{projectName}/jwks/{jwkName}/

​
Authentication

Requires a Personal API Access Token. 
Authorization: Bearer YOUR_TOKEN

​
Request

​
Headers

HeaderValueRequired
AuthorizationBearer {token}Yes

​
Path Parameters

ParameterTypeRequiredDescription
projectNamestringYesProject name
jwkNamestringYesName of the JWK

​
Response

​
Success Response (200 OK)

{
  "success": true,
  "resultList": [
    {
      "name": "my-jwk",
      "description": "JWK for API authentication",
      "projectId": "project-id",
      "sourceType": "URL",
      "sourceId": null,
      "sourceUrl": "https://example.com/.well-known/jwks.json",
      "type": "RSA",
      "kid": "key-id-1",
      "rsa": {
        "n": "modulus-value",
        "e": "AQAB",
        "d": "private-exponent",
        "p": "prime1",
        "q": "prime2"
      }
    }
  ]
}

​
Response Fields

FieldTypeDescription
successbooleanIndicates if the request was successful
resultListarray[object]List containing the JWK (single item)

​
JWK Object

FieldTypeDescription
namestringJWK name
descriptionstringJWK description
projectIdstringProject ID where JWK belongs
sourceTypestringSource type: URL, COPY_PASTE, CERTIFICATE, PUBLIC_KEY, PRIVATE_KEY, KEYSTORE, GENERATE
sourceIdstringID of the source (certificate, key, or keystore) if applicable
sourceUrlstringURL of the source if sourceType is URL
typestringJWK type: RSA, EC, OCT, OKP
kidstringKey ID (kid) of the JWK. For URL and COPY_PASTE source types, this specifies which key to use when the source contains multiple keys (JWK Set)
rsaobjectRSA key material (if type is RSA)
ecobjectElliptic Curve key material (if type is EC)
octobjectOctet sequence key material (if type is OCT)
okpobjectOctet Key Pair key material (if type is OKP)

​
Notes

  • This endpoint returns the complete JWK including key material
  • Key material is decrypted and returned in the response
  • Use List JWKs endpoint for a lightweight list without key material

​
Error Response (400 Bad Request)

{
  "error": "bad_request",
  "error_description": "JWK (name: my-jwk) is not found!"
}

​
cURL Example

curl -X GET \
  "https://demo.apinizer.com/apiops/projects/MyProject/jwks/my-jwk/" \
  -H "Authorization: Bearer YOUR_TOKEN"

​
Notes and Warnings

  • Key Material:
    • Full key material is returned in the response
    • Private keys are included for RSA, EC, and OKP types
    • Handle key material securely
  • Performance:
    • This endpoint returns complete JWK data
    • Use List JWKs for better performance when key material is not needed

​
Permissions

User must have any permission in the project (read access).