KeyProperties interface

The properties of the key.

Properties

attributes

The attributes of the key.

curveName

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

keyOps
keySize

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

keyUri

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.

keyUriWithVersion

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.

kty

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

releasePolicy

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

rotationPolicy

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

Property Details

attributes

The attributes of the key.

attributes?: KeyAttributes

Property Value

curveName

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

curveName?: string

Property Value

string

keyOps

keyOps?: string[]

Property Value

string[]

keySize

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

keySize?: number

Property Value

number

keyUri

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.

keyUri?: string

Property Value

string

keyUriWithVersion

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.

keyUriWithVersion?: string

Property Value

string

kty

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

kty?: string

Property Value

string

releasePolicy

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

releasePolicy?: KeyReleasePolicy

Property Value

rotationPolicy

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

rotationPolicy?: RotationPolicy

Property Value