Skip to main content

JsonWebKey

A JSON object that represents a cryptographic key. The members of the object represent properties of the key, including its value.

Elements

NameRequiredTypeDescription
activeboolean

Details

Whether this key is in active use.

algstring

Details

The specific cryptographic algorithm used with the key.

ktystring

Details

The family of cryptographic algorithms used with the key.

usestring

Details

How the key was meant to be used; sig represents the signature.

key_opsstring[]

Details

The operation(s) for which the key is intended to be used.

x5cstring[]

Details

The 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.

nstring

Details

The modulus for the RSA public key.

estring

Details

The exponent for the RSA public key.

kidstring

Details

The unique identifier for the key.

x5tstring

Details

The thumbprint of the x.509 cert (SHA-1 thumbprint).

dstring

Details

The exponent for the RSA private key.

pstring

Details

The first prime factor.

qstring

Details

The second prime factor.

dpstring

Details

The first factor CRT exponent.

dqstring

Details

The second factor CRT exponent.

qistring

Details

The first CRT coefficient.

Search Parameters

NameTypeDescriptionExpression
activetokenWhether the JWK is activeJsonWebKey.active

Inherited Elements

NameRequiredTypeDescription
idstring

Logical id of this artifact

Details

The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

metaMeta

Details

The 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.

implicitRulesuri

Details

A 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.

languagecode

Details

The base language in which the resource is written.

textNarrative

Text summary of the resource, for human interpretation

Details

A 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.

containedResource[]

Contained, inline Resources

Details

These 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.

extensionExtension[]

Additional content defined by implementations

Details

May 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.

modifierExtensionExtension[]

Extensions that cannot be ignored

Details

May 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).