JsonWebKey
A JSON object that represents a cryptographic key. The members of the object represent properties of the key, including its value.
- Schema
Elements
Name | Required | Type | Description |
---|---|---|---|
active | boolean | DetailsWhether this key is in active use. | |
alg | string | DetailsThe specific cryptographic algorithm used with the key. | |
kty | string | DetailsThe family of cryptographic algorithms used with the key. | |
use | string | DetailsHow the key was meant to be used; sig represents the signature. | |
key_ops | string[] | DetailsThe operation(s) for which the key is intended to be used. | |
x5c | string[] | DetailsThe x.509 certificate chain. The first entry in the array is the certificate to use for token verification; the other certificates can be used to verify this first certificate. | |
n | string | DetailsThe modulus for the RSA public key. | |
e | string | DetailsThe exponent for the RSA public key. | |
kid | string | DetailsThe unique identifier for the key. | |
x5t | string | DetailsThe thumbprint of the x.509 cert (SHA-1 thumbprint). | |
d | string | DetailsThe exponent for the RSA private key. | |
p | string | DetailsThe first prime factor. | |
q | string | DetailsThe second prime factor. | |
dp | string | DetailsThe first factor CRT exponent. | |
dq | string | DetailsThe second factor CRT exponent. | |
qi | string | DetailsThe first CRT coefficient. |
Search Parameters
Name | Type | Description | Expression |
---|---|---|---|
active | token | Whether the JWK is active | JsonWebKey.active |
Inherited Elements
Name | Required | Type | Description |
---|---|---|---|
id | string | Logical id of this artifact DetailsThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. | |
meta | Meta | DetailsThe metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. | |
implicitRules | uri | DetailsA reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. | |
language | code | DetailsThe base language in which the resource is written. | |
text | Narrative | Text summary of the resource, for human interpretation DetailsA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. | |
contained | Resource[] | Contained, inline Resources DetailsThese resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. | |
extension | Extension[] | Additional content defined by implementations DetailsMay be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | |
modifierExtension | Extension[] | Extensions that cannot be ignored DetailsMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |