Dela via


Get Public Keys - Get Public Keys

Hämta de offentliga nycklar som används av tjänsten för att signera kvitton, som nämns i IETF SCITT-utkastet som en del av implementeringen jwks_uri

GET {endpoint}/jwks?api-version=2025-01-31-preview

URI-parametrar

Name I Obligatorisk Typ Description
endpoint
path True

string (uri)

api-version
query True

string

minLength: 1

Den API-version som ska användas för den här åtgärden.

Svar

Name Typ Description
200 OK

JwksDocument

Begäran har slutförts.

Media Types: "application/json", "application/concise-problem-details+cbor"

400 Bad Request

file

Svar på valideringsfel

Media Types: "application/json", "application/concise-problem-details+cbor"

404 Not Found

file

Felsvar hittades inte

Media Types: "application/json", "application/concise-problem-details+cbor"

429 Too Many Requests

file

Felsvar hittades inte

Media Types: "application/json", "application/concise-problem-details+cbor"

Sidhuvuden

Retry-After: integer

500 Internal Server Error

file

Svar på serverfel

Media Types: "application/json", "application/concise-problem-details+cbor"

Other Status Codes

file

Felsvar om tjänsten är inte tillgänglig

Media Types: "application/json", "application/concise-problem-details+cbor"

Sidhuvuden

Retry-After: integer

Exempel

GetPublicKeys

Exempelbegäran

GET {endpoint}/jwks?api-version=2025-01-31-preview

Exempelsvar

Content-Type: application/json
{
  "keys": [
    {
      "alg": "ismwdpkyzdpcdsxlhdrcyu",
      "crv": "krvghelqczlomlykmvq",
      "d": "sjrntenzgpayzxqeyylodzzot",
      "dp": "okaildkxkhdiuz",
      "dq": "cr",
      "e": "whulawpi",
      "k": "umuebehxryklpmphgvfflgxhmw",
      "kid": "sjvhzuxmiidkyt",
      "kty": "aleunvywecrqn",
      "n": "agbjjczwjkuzidwazv",
      "p": "mwqnfqougntmfkkqrhwfawqdfvc",
      "q": "ihgggpjpvqrugoctea",
      "qi": "hauoxhsdatbqpwyjy",
      "use": "sobsnevfheiclufbfronhqufiry",
      "x": "jiifvniadtvfdosxgtdgju",
      "x5c": [
        "bpqymrr"
      ],
      "y": "owpcmhs"
    }
  ]
}
Content-Type: application/concise-problem-details+cbor
"{binary}"
Content-Type: application/concise-problem-details+cbor
"{binary}"
Content-Type: application/concise-problem-details+cbor
"{binary}"
Content-Type: application/concise-problem-details+cbor
"{binary}"
Content-Type: application/concise-problem-details+cbor
"{binary}"

Definitioner

Name Description
JsonWebKey

rfc7517 Representation av JSON-webbnyckel anpassad från en delad Swagger-definition i de vanliga typerna

JwksDocument

Ett JWKS-liknande dokument

JsonWebKey

rfc7517 Representation av JSON-webbnyckel anpassad från en delad Swagger-definition i de vanliga typerna

Name Typ Description
alg

string

Parametern "alg" (algoritm) identifierar den algoritm som är avsedd att användas med nyckeln. De värden som används bör antingen registreras i IANA-registret "JSON Web Signature and Encryption Algorithms" som upprättats av [JWA] eller vara ett värde som innehåller ett kollisionsbeständigt namn.

crv

string

Parametern "crv" (kurva) identifierar kurvtypen

d

string

Privat RSA-exponent eller PRIVAT ECC-nyckel

dp

string

RSA Private Key-parameter

dq

string

RSA Private Key-parameter

e

string

Offentlig RSA-exponent i Base64

k

string

Symmetrisk nyckel

kid

string

Parametern "kid" (nyckel-ID) används för att matcha en specifik nyckel. Detta används till exempel för att välja bland en uppsättning nycklar i en JWK-uppsättning under nyckelåterställning. Strukturen för "kid"-värdet är ospecificerad. När "kid"-värden används i en JWK-uppsättning använder olika nycklar i JWK-uppsättningen distinkta "kid"-värden. (Ett exempel där olika nycklar kan använda samma "kid"-värde är om de har olika "kty" (nyckeltyp) men anses vara likvärdiga alternativ av programmet som använder dem.) Värdet "kid" är en skiftlägeskänslig sträng.

kty

string

Parametern "kty" (nyckeltyp) identifierar den kryptografiska algoritmfamilj som används med nyckeln, till exempel "RSA" eller "EC". "kty"-värden bör antingen registreras i IANA-registret "JSON Web Key Types" som upprättats av [JWA] eller vara ett värde som innehåller ett kollisionsbeständigt namn. Värdet "kty" är en skiftlägeskänslig sträng.

n

string

RSA-modulus i Base64

p

string

RSA hemliga prime

q

string

RSA secret prime, med p < q

qi

string

RSA Private Key-parameter

use

string

Använd ("offentlig nyckelanvändning") identifierar den avsedda användningen av den offentliga nyckeln. Parametern "use" används för att ange om en offentlig nyckel används för att kryptera data eller verifiera signaturen för data. Värden är ofta "sig" (signatur) eller "enc" (kryptering).

x

string

X-koordinat för den elliptiska kurvpunkten

x5c

string[]

Parametern "x5c" (X.509 certificate chain) innehåller en kedja med ett eller flera PKIX-certifikat [RFC5280]. Certifikatkedjan representeras som en JSON-matris med certifikatvärdesträngar. Varje sträng i matrisen är en base64-kodad (avsnitt 4 i [RFC4648] – inte base64url-kodad) DER [ITU. X690.1994] PKIX-certifikatvärde. PKIX-certifikatet som innehåller nyckelvärdet MÅSTE vara det första certifikatet.

y

string

Y-koordinat för den elliptiska kurvpunkten

JwksDocument

Ett JWKS-liknande dokument

Name Typ Description
keys

JsonWebKey[]

Lista över offentliga nycklar som används för kvittoverifiering.