Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface KeyProperties

Package version

The properties of the key.

Hierarchy

  • KeyProperties

Index

Properties

Optional attributes

attributes: KeyAttributes

The attributes of the key.

Optional curveName

The elliptic curve name. For valid values, see JsonWebKeyCurveName.

Optional keyOps

Optional keySize

keySize: undefined | number

The key size in bits. For example: 2048, 3072, or 4096 for RSA.

Optional keyUri

keyUri: undefined | string

The URI to retrieve the current version of the key. NOTE: This property will not be serialized. It can only be populated by the server.

Optional keyUriWithVersion

keyUriWithVersion: undefined | string

The URI to retrieve the specific version of the key. NOTE: This property will not be serialized. It can only be populated by the server.

Optional kty

The type of the key. For valid values, see JsonWebKeyType.

Optional releasePolicy

releasePolicy: KeyReleasePolicy

Key release policy in response. It will be used for both output and input. Omitted if empty

Optional rotationPolicy

rotationPolicy: RotationPolicy

Key rotation policy in response. It will be used for both output and input. Omitted if empty

Generated using TypeDoc