Skip to content

JWT

Security (JWT) service implementation.

JWT

Bases: ONVIFService

0.0.1 23.12

Security (JWT) service client.

Property Details
First introduced ONVIF 23.12 (December 2023)
Binding name JWTBinding (ver10/advancedsecurity/wsdl/advancedsecurity.wsdl)
Operations advancedsecurity.wsdl
Spec Security

GetJWTConfiguration 

GetJWTConfiguration()

This operation returns the parameters of the JWT authorization used by the device.

Output
  • Configuration [JWTConfiguration]
    • Audiences [StringList]
      List of supported aud claims. A JWT must contain at least one of these.
    • TrustedIssuers - optional, unbounded; [anyURI]
      If present, this is the list to URIs pointing to the metadata file conforming to RFC8414, such as "https://your.domain/.well-known/openid-configuration" , of the trusted Open ID Connect servers issuing JWT tokens. Using metadata, the device can reach the information about the JWKS and implement the rotation of the keys accordingly.
    • KeyID - optional, unbounded; [KeyID]
      If present, this is the list of keys provided out of band to verify the origin and integrity of the JWT.
      Maximum length: 64
    • ValidationPolicy - optional; [CertPathValidationPolicyID]
      If present, the device will validate the certification path of the Open ID Connect servers. The OIDC server iso considered to be valid if its certificate is validated by the provided certification path validation policy.
      Maximum length: 64
    • CustomClaims - optional, unbounded; [CustomClaim]
      A list of optional custom claims to be used for JWT validation.
      • Name [string]
        Custom claim name.
      • SupportedValues [StringList]
        List of supported custom claim values. A JWT must contain at least one of these.

SetJWTConfiguration 

SetJWTConfiguration(Configuration)

This operation sets the parameters of the JWT authorization used by the device.

Input
  • Configuration [JWTConfiguration]
    • Audiences [StringList]
      List of supported aud claims. A JWT must contain at least one of these.
    • TrustedIssuers - optional, unbounded; [anyURI]
      If present, this is the list to URIs pointing to the metadata file conforming to RFC8414, such as "https://your.domain/.well-known/openid-configuration" , of the trusted Open ID Connect servers issuing JWT tokens. Using metadata, the device can reach the information about the JWKS and implement the rotation of the keys accordingly.
    • KeyID - optional, unbounded; [KeyID]
      If present, this is the list of keys provided out of band to verify the origin and integrity of the JWT.
      Maximum length: 64
    • ValidationPolicy - optional; [CertPathValidationPolicyID]
      If present, the device will validate the certification path of the Open ID Connect servers. The OIDC server iso considered to be valid if its certificate is validated by the provided certification path validation policy.
      Maximum length: 64
    • CustomClaims - optional, unbounded; [CustomClaim]
      A list of optional custom claims to be used for JWT validation.
      • Name [string]
        Custom claim name.
      • SupportedValues [StringList]
        List of supported custom claim values. A JWT must contain at least one of these.