Skip to content

AuthorizationServer

Security (AuthorizationServer) service implementation.

AuthorizationServer

Bases: ONVIFService

0.0.1 23.12

Security (AuthorizationServer) service client.

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

GetAuthorizationServerConfigurations 

GetAuthorizationServerConfigurations(Token=None)

This operation lists all existing authorization server configurations for the device.

Input
  • Token - optional; [ReferenceToken]
    Maximum length: 64
Output
  • Configuration - optional, unbounded; [AuthorizationServerConfiguration]
    • Data [AuthorizationServerConfigurationData]
      • Type - required; [string]
        The type of configuration, tas:AuthorizationServerConfigurationType lists the acceptable values
      • ClientAuth - optional; [string]
        How to authenticate with the server, tas:ClientAuthenticationMethod lists the acceptable values
      • ServerUri [anyURI]
        Authorization server metadata endpoint conforming to RFC8414, such as "https://your.domain/.well-known/openid-configuration"
      • ClientID - optional; [string]
        Client identifier issued by the authorization server
      • ClientSecret - optional; [string]
        Client secret used to authenticate with the authorization server
      • Scope - optional; [string]
        The requested access scope(s)
      • KeyID - optional; [KeyID]
        Key identifier for the private_key_jwt authentication method
        Maximum length: 64
      • CertificateID - optional; [CertificateID]
        Certificate identifier for the self_signed_tls_client_auth authentication method
        Maximum length: 64
      • CertPathValidationPolicyID - optional; [CertPathValidationPolicyID]
        The unique identifier of the certification path validation policy to be used for validating the server certificate.
        Maximum length: 64

CreateAuthorizationServerConfiguration 

CreateAuthorizationServerConfiguration(Configuration)

This operation creates a new authorization server configuration.

The configuration data shall be created in the device and shall be persistent (remain after reboot).

Input
  • Configuration [AuthorizationServerConfigurationData]
    • Type - required; [string]
      The type of configuration, tas:AuthorizationServerConfigurationType lists the acceptable values
    • ClientAuth - optional; [string]
      How to authenticate with the server, tas:ClientAuthenticationMethod lists the acceptable values
    • ServerUri [anyURI]
      Authorization server metadata endpoint conforming to RFC8414, such as "https://your.domain/.well-known/openid-configuration"
    • ClientID - optional; [string]
      Client identifier issued by the authorization server
    • ClientSecret - optional; [string]
      Client secret used to authenticate with the authorization server
    • Scope - optional; [string]
      The requested access scope(s)
    • KeyID - optional; [KeyID]
      Key identifier for the private_key_jwt authentication method
      Maximum length: 64
    • CertificateID - optional; [CertificateID]
      Certificate identifier for the self_signed_tls_client_auth authentication method
      Maximum length: 64
    • CertPathValidationPolicyID - optional; [CertPathValidationPolicyID]
      The unique identifier of the certification path validation policy to be used for validating the server certificate.
      Maximum length: 64
Output
  • Token [ReferenceToken]
    Maximum length: 64

SetAuthorizationServerConfiguration 

SetAuthorizationServerConfiguration(Configuration)

This operation modifies an existing authorization server configuration.

Input
  • Configuration [AuthorizationServerConfiguration]
    • Data [AuthorizationServerConfigurationData]
      • Type - required; [string]
        The type of configuration, tas:AuthorizationServerConfigurationType lists the acceptable values
      • ClientAuth - optional; [string]
        How to authenticate with the server, tas:ClientAuthenticationMethod lists the acceptable values
      • ServerUri [anyURI]
        Authorization server metadata endpoint conforming to RFC8414, such as "https://your.domain/.well-known/openid-configuration"
      • ClientID - optional; [string]
        Client identifier issued by the authorization server
      • ClientSecret - optional; [string]
        Client secret used to authenticate with the authorization server
      • Scope - optional; [string]
        The requested access scope(s)
      • KeyID - optional; [KeyID]
        Key identifier for the private_key_jwt authentication method
        Maximum length: 64
      • CertificateID - optional; [CertificateID]
        Certificate identifier for the self_signed_tls_client_auth authentication method
        Maximum length: 64
      • CertPathValidationPolicyID - optional; [CertPathValidationPolicyID]
        The unique identifier of the certification path validation policy to be used for validating the server certificate.
        Maximum length: 64

DeleteAuthorizationServerConfiguration 

DeleteAuthorizationServerConfiguration(Token)

This operation deletes the given authorization server configuration and configuration change shall always be persistent.

Input
  • Token [ReferenceToken]
    Maximum length: 64