Hierarchy

  • CertMatchingRuleService

Constructors

Methods

  • Create a Certificate Matching Rule object. Create a Certificate Matching Rule object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.

    A Cert Matching Rule is a collection of conditions and attribute filters that all have to be satisfied for certificate to be acceptable as authentication for a given username.

    Attribute Identifying Required Read-Only Write-Only Deprecated Opaque
    msgVpnName x x
    ruleName x x

    A SEMP client authorized with a minimum access scope/level of "global/read-write" is required to perform this operation.

    This has been available since 2.27.

    Returns

    MsgVpnCertMatchingRuleResponse The Certificate Matching Rule object's attributes after being created, and the request metadata.

    Returns

    SempMetaOnlyResponse The error response.

    Throws

    ApiError

    Parameters

    • __namedParameters: {
          body: MsgVpnCertMatchingRule;
          msgVpnName: string;
          opaquePassword?: string;
          select?: string[];
          xContextId?: string;
      }
      • body: MsgVpnCertMatchingRule

        The Certificate Matching Rule object's attributes. *

      • msgVpnName: string

        The name of the Message VPN. *

      • Optional opaquePassword?: string

        Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the opaquePassword parameter. *

      • Optional select?: string[]

        Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the select parameter. *

      • Optional xContextId?: string

        Optional context id the request is running. *

    Returns CancelablePromise<MsgVpnCertMatchingRuleResponse | SempMetaOnlyResponse>

  • Create a Certificate Matching Rule Attribute Filter object. Create a Certificate Matching Rule Attribute Filter object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.

    A Cert Matching Rule Attribute Filter compares a username attribute to a string.

    Attribute Identifying Required Read-Only Write-Only Deprecated Opaque
    filterName x x
    msgVpnName x x
    ruleName x x

    A SEMP client authorized with a minimum access scope/level of "global/read-write" is required to perform this operation.

    This has been available since 2.28.

    Returns

    MsgVpnCertMatchingRuleAttributeFilterResponse The Certificate Matching Rule Attribute Filter object's attributes after being created, and the request metadata.

    Returns

    SempMetaOnlyResponse The error response.

    Throws

    ApiError

    Parameters

    • __namedParameters: {
          body: MsgVpnCertMatchingRuleAttributeFilter;
          msgVpnName: string;
          opaquePassword?: string;
          ruleName: string;
          select?: string[];
          xContextId?: string;
      }
      • body: MsgVpnCertMatchingRuleAttributeFilter

        The Certificate Matching Rule Attribute Filter object's attributes. *

      • msgVpnName: string

        The name of the Message VPN. *

      • Optional opaquePassword?: string

        Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the opaquePassword parameter. *

      • ruleName: string

        The name of the rule. *

      • Optional select?: string[]

        Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the select parameter. *

      • Optional xContextId?: string

        Optional context id the request is running. *

    Returns CancelablePromise<MsgVpnCertMatchingRuleAttributeFilterResponse | SempMetaOnlyResponse>

  • Create a Certificate Matching Rule Condition object. Create a Certificate Matching Rule Condition object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.

    A Cert Matching Rule Condition compares data extracted from a certificate to a username attribute or an expression.

    Attribute Identifying Required Read-Only Write-Only Deprecated Opaque
    msgVpnName x x
    ruleName x x
    source x x

    A SEMP client authorized with a minimum access scope/level of "global/read-write" is required to perform this operation.

    This has been available since 2.27.

    Returns

    MsgVpnCertMatchingRuleConditionResponse The Certificate Matching Rule Condition object's attributes after being created, and the request metadata.

    Returns

    SempMetaOnlyResponse The error response.

    Throws

    ApiError

    Parameters

    • __namedParameters: {
          body: MsgVpnCertMatchingRuleCondition;
          msgVpnName: string;
          opaquePassword?: string;
          ruleName: string;
          select?: string[];
          xContextId?: string;
      }
      • body: MsgVpnCertMatchingRuleCondition

        The Certificate Matching Rule Condition object's attributes. *

      • msgVpnName: string

        The name of the Message VPN. *

      • Optional opaquePassword?: string

        Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the opaquePassword parameter. *

      • ruleName: string

        The name of the rule. *

      • Optional select?: string[]

        Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the select parameter. *

      • Optional xContextId?: string

        Optional context id the request is running. *

    Returns CancelablePromise<MsgVpnCertMatchingRuleConditionResponse | SempMetaOnlyResponse>

  • Delete a Certificate Matching Rule object. Delete a Certificate Matching Rule object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync.

    A Cert Matching Rule is a collection of conditions and attribute filters that all have to be satisfied for certificate to be acceptable as authentication for a given username.

    A SEMP client authorized with a minimum access scope/level of "global/read-write" is required to perform this operation.

    This has been available since 2.27.

    Returns

    SempMetaOnlyResponse The request metadata.

    Throws

    ApiError

    Parameters

    • __namedParameters: {
          msgVpnName: string;
          ruleName: string;
          xContextId?: string;
      }
      • msgVpnName: string

        The name of the Message VPN. *

      • ruleName: string

        The name of the rule. *

      • Optional xContextId?: string

        Optional context id the request is running. *

    Returns CancelablePromise<SempMetaOnlyResponse>

  • Delete a Certificate Matching Rule Attribute Filter object. Delete a Certificate Matching Rule Attribute Filter object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync.

    A Cert Matching Rule Attribute Filter compares a username attribute to a string.

    A SEMP client authorized with a minimum access scope/level of "global/read-write" is required to perform this operation.

    This has been available since 2.28.

    Returns

    SempMetaOnlyResponse The request metadata.

    Throws

    ApiError

    Parameters

    • __namedParameters: {
          filterName: string;
          msgVpnName: string;
          ruleName: string;
          xContextId?: string;
      }
      • filterName: string

        The name of the filter. *

      • msgVpnName: string

        The name of the Message VPN. *

      • ruleName: string

        The name of the rule. *

      • Optional xContextId?: string

        Optional context id the request is running. *

    Returns CancelablePromise<SempMetaOnlyResponse>

  • Delete a Certificate Matching Rule Condition object. Delete a Certificate Matching Rule Condition object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync.

    A Cert Matching Rule Condition compares data extracted from a certificate to a username attribute or an expression.

    A SEMP client authorized with a minimum access scope/level of "global/read-write" is required to perform this operation.

    This has been available since 2.27.

    Returns

    SempMetaOnlyResponse The request metadata.

    Throws

    ApiError

    Parameters

    • __namedParameters: {
          msgVpnName: string;
          ruleName: string;
          source: string;
          xContextId?: string;
      }
      • msgVpnName: string

        The name of the Message VPN. *

      • ruleName: string

        The name of the rule. *

      • source: string

        Certificate field to be compared with the Attribute. *

      • Optional xContextId?: string

        Optional context id the request is running. *

    Returns CancelablePromise<SempMetaOnlyResponse>

  • Get a Certificate Matching Rule object. Get a Certificate Matching Rule object.

    A Cert Matching Rule is a collection of conditions and attribute filters that all have to be satisfied for certificate to be acceptable as authentication for a given username.

    Attribute Identifying Write-Only Deprecated Opaque
    msgVpnName x
    ruleName x

    A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation.

    This has been available since 2.27.

    Returns

    MsgVpnCertMatchingRuleResponse The Certificate Matching Rule object's attributes, and the request metadata.

    Returns

    SempMetaOnlyResponse The error response.

    Throws

    ApiError

    Parameters

    • __namedParameters: {
          msgVpnName: string;
          opaquePassword?: string;
          ruleName: string;
          select?: string[];
          xContextId?: string;
      }
      • msgVpnName: string

        The name of the Message VPN. *

      • Optional opaquePassword?: string

        Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the opaquePassword parameter. *

      • ruleName: string

        The name of the rule. *

      • Optional select?: string[]

        Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the select parameter. *

      • Optional xContextId?: string

        Optional context id the request is running. *

    Returns CancelablePromise<MsgVpnCertMatchingRuleResponse | SempMetaOnlyResponse>

  • Get a Certificate Matching Rule Attribute Filter object. Get a Certificate Matching Rule Attribute Filter object.

    A Cert Matching Rule Attribute Filter compares a username attribute to a string.

    Attribute Identifying Write-Only Deprecated Opaque
    filterName x
    msgVpnName x
    ruleName x

    A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation.

    This has been available since 2.28.

    Returns

    MsgVpnCertMatchingRuleAttributeFilterResponse The Certificate Matching Rule Attribute Filter object's attributes, and the request metadata.

    Returns

    SempMetaOnlyResponse The error response.

    Throws

    ApiError

    Parameters

    • __namedParameters: {
          filterName: string;
          msgVpnName: string;
          opaquePassword?: string;
          ruleName: string;
          select?: string[];
          xContextId?: string;
      }
      • filterName: string

        The name of the filter. *

      • msgVpnName: string

        The name of the Message VPN. *

      • Optional opaquePassword?: string

        Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the opaquePassword parameter. *

      • ruleName: string

        The name of the rule. *

      • Optional select?: string[]

        Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the select parameter. *

      • Optional xContextId?: string

        Optional context id the request is running. *

    Returns CancelablePromise<MsgVpnCertMatchingRuleAttributeFilterResponse | SempMetaOnlyResponse>

  • Get a list of Certificate Matching Rule Attribute Filter objects. Get a list of Certificate Matching Rule Attribute Filter objects.

    A Cert Matching Rule Attribute Filter compares a username attribute to a string.

    Attribute Identifying Write-Only Deprecated Opaque
    filterName x
    msgVpnName x
    ruleName x

    A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation.

    This has been available since 2.28.

    Returns

    MsgVpnCertMatchingRuleAttributeFiltersResponse The list of Certificate Matching Rule Attribute Filter objects' attributes, and the request metadata.

    Returns

    SempMetaOnlyResponse The error response.

    Throws

    ApiError

    Parameters

    • __namedParameters: {
          count?: number;
          cursor?: string;
          msgVpnName: string;
          opaquePassword?: string;
          ruleName: string;
          select?: string[];
          where?: string[];
          xContextId?: string;
      }
      • Optional count?: number

        Limit the count of objects in the response. See the documentation for the count parameter. *

      • Optional cursor?: string

        The cursor, or position, for the next page of objects. See the documentation for the cursor parameter. *

      • msgVpnName: string

        The name of the Message VPN. *

      • Optional opaquePassword?: string

        Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the opaquePassword parameter. *

      • ruleName: string

        The name of the rule. *

      • Optional select?: string[]

        Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the select parameter. *

      • Optional where?: string[]

        Include in the response only objects where certain conditions are true. See the the documentation for the where parameter. *

      • Optional xContextId?: string

        Optional context id the request is running. *

    Returns CancelablePromise<MsgVpnCertMatchingRuleAttributeFiltersResponse | SempMetaOnlyResponse>

  • Get a Certificate Matching Rule Condition object. Get a Certificate Matching Rule Condition object.

    A Cert Matching Rule Condition compares data extracted from a certificate to a username attribute or an expression.

    Attribute Identifying Write-Only Deprecated Opaque
    msgVpnName x
    ruleName x
    source x

    A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation.

    This has been available since 2.27.

    Returns

    MsgVpnCertMatchingRuleConditionResponse The Certificate Matching Rule Condition object's attributes, and the request metadata.

    Returns

    SempMetaOnlyResponse The error response.

    Throws

    ApiError

    Parameters

    • __namedParameters: {
          msgVpnName: string;
          opaquePassword?: string;
          ruleName: string;
          select?: string[];
          source: string;
          xContextId?: string;
      }
      • msgVpnName: string

        The name of the Message VPN. *

      • Optional opaquePassword?: string

        Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the opaquePassword parameter. *

      • ruleName: string

        The name of the rule. *

      • Optional select?: string[]

        Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the select parameter. *

      • source: string

        Certificate field to be compared with the Attribute. *

      • Optional xContextId?: string

        Optional context id the request is running. *

    Returns CancelablePromise<MsgVpnCertMatchingRuleConditionResponse | SempMetaOnlyResponse>

  • Get a list of Certificate Matching Rule Condition objects. Get a list of Certificate Matching Rule Condition objects.

    A Cert Matching Rule Condition compares data extracted from a certificate to a username attribute or an expression.

    Attribute Identifying Write-Only Deprecated Opaque
    msgVpnName x
    ruleName x
    source x

    A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation.

    This has been available since 2.27.

    Returns

    MsgVpnCertMatchingRuleConditionsResponse The list of Certificate Matching Rule Condition objects' attributes, and the request metadata.

    Returns

    SempMetaOnlyResponse The error response.

    Throws

    ApiError

    Parameters

    • __namedParameters: {
          count?: number;
          cursor?: string;
          msgVpnName: string;
          opaquePassword?: string;
          ruleName: string;
          select?: string[];
          where?: string[];
          xContextId?: string;
      }
      • Optional count?: number

        Limit the count of objects in the response. See the documentation for the count parameter. *

      • Optional cursor?: string

        The cursor, or position, for the next page of objects. See the documentation for the cursor parameter. *

      • msgVpnName: string

        The name of the Message VPN. *

      • Optional opaquePassword?: string

        Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the opaquePassword parameter. *

      • ruleName: string

        The name of the rule. *

      • Optional select?: string[]

        Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the select parameter. *

      • Optional where?: string[]

        Include in the response only objects where certain conditions are true. See the the documentation for the where parameter. *

      • Optional xContextId?: string

        Optional context id the request is running. *

    Returns CancelablePromise<MsgVpnCertMatchingRuleConditionsResponse | SempMetaOnlyResponse>

  • Get a list of Certificate Matching Rule objects. Get a list of Certificate Matching Rule objects.

    A Cert Matching Rule is a collection of conditions and attribute filters that all have to be satisfied for certificate to be acceptable as authentication for a given username.

    Attribute Identifying Write-Only Deprecated Opaque
    msgVpnName x
    ruleName x

    A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation.

    This has been available since 2.27.

    Returns

    MsgVpnCertMatchingRulesResponse The list of Certificate Matching Rule objects' attributes, and the request metadata.

    Returns

    SempMetaOnlyResponse The error response.

    Throws

    ApiError

    Parameters

    • __namedParameters: {
          count?: number;
          cursor?: string;
          msgVpnName: string;
          opaquePassword?: string;
          select?: string[];
          where?: string[];
          xContextId?: string;
      }
      • Optional count?: number

        Limit the count of objects in the response. See the documentation for the count parameter. *

      • Optional cursor?: string

        The cursor, or position, for the next page of objects. See the documentation for the cursor parameter. *

      • msgVpnName: string

        The name of the Message VPN. *

      • Optional opaquePassword?: string

        Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the opaquePassword parameter. *

      • Optional select?: string[]

        Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the select parameter. *

      • Optional where?: string[]

        Include in the response only objects where certain conditions are true. See the the documentation for the where parameter. *

      • Optional xContextId?: string

        Optional context id the request is running. *

    Returns CancelablePromise<MsgVpnCertMatchingRulesResponse | SempMetaOnlyResponse>

  • Replace a Certificate Matching Rule object. Replace a Certificate Matching Rule object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4.

    A Cert Matching Rule is a collection of conditions and attribute filters that all have to be satisfied for certificate to be acceptable as authentication for a given username.

    Attribute Identifying Const Read-Only Write-Only Requires-Disable Deprecated Opaque
    msgVpnName x x
    ruleName x x

    A SEMP client authorized with a minimum access scope/level of "global/read-write" is required to perform this operation.

    This has been available since 2.27.

    Returns

    MsgVpnCertMatchingRuleResponse The Certificate Matching Rule object's attributes after being replaced, and the request metadata.

    Returns

    SempMetaOnlyResponse The error response.

    Throws

    ApiError

    Parameters

    • __namedParameters: {
          body: MsgVpnCertMatchingRule;
          msgVpnName: string;
          opaquePassword?: string;
          ruleName: string;
          select?: string[];
          xContextId?: string;
      }
      • body: MsgVpnCertMatchingRule

        The Certificate Matching Rule object's attributes. *

      • msgVpnName: string

        The name of the Message VPN. *

      • Optional opaquePassword?: string

        Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the opaquePassword parameter. *

      • ruleName: string

        The name of the rule. *

      • Optional select?: string[]

        Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the select parameter. *

      • Optional xContextId?: string

        Optional context id the request is running. *

    Returns CancelablePromise<MsgVpnCertMatchingRuleResponse | SempMetaOnlyResponse>

  • Replace a Certificate Matching Rule Attribute Filter object. Replace a Certificate Matching Rule Attribute Filter object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4.

    A Cert Matching Rule Attribute Filter compares a username attribute to a string.

    Attribute Identifying Const Read-Only Write-Only Requires-Disable Deprecated Opaque
    filterName x x
    msgVpnName x x
    ruleName x x

    A SEMP client authorized with a minimum access scope/level of "global/read-write" is required to perform this operation.

    This has been available since 2.28.

    Returns

    MsgVpnCertMatchingRuleAttributeFilterResponse The Certificate Matching Rule Attribute Filter object's attributes after being replaced, and the request metadata.

    Returns

    SempMetaOnlyResponse The error response.

    Throws

    ApiError

    Parameters

    • __namedParameters: {
          body: MsgVpnCertMatchingRuleAttributeFilter;
          filterName: string;
          msgVpnName: string;
          opaquePassword?: string;
          ruleName: string;
          select?: string[];
          xContextId?: string;
      }
      • body: MsgVpnCertMatchingRuleAttributeFilter

        The Certificate Matching Rule Attribute Filter object's attributes. *

      • filterName: string

        The name of the filter. *

      • msgVpnName: string

        The name of the Message VPN. *

      • Optional opaquePassword?: string

        Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the opaquePassword parameter. *

      • ruleName: string

        The name of the rule. *

      • Optional select?: string[]

        Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the select parameter. *

      • Optional xContextId?: string

        Optional context id the request is running. *

    Returns CancelablePromise<MsgVpnCertMatchingRuleAttributeFilterResponse | SempMetaOnlyResponse>

  • Update a Certificate Matching Rule object. Update a Certificate Matching Rule object. Any attribute missing from the request will be left unchanged.

    A Cert Matching Rule is a collection of conditions and attribute filters that all have to be satisfied for certificate to be acceptable as authentication for a given username.

    Attribute Identifying Read-Only Write-Only Requires-Disable Deprecated Opaque
    msgVpnName x x
    ruleName x x

    A SEMP client authorized with a minimum access scope/level of "global/read-write" is required to perform this operation.

    This has been available since 2.27.

    Returns

    MsgVpnCertMatchingRuleResponse The Certificate Matching Rule object's attributes after being updated, and the request metadata.

    Returns

    SempMetaOnlyResponse The error response.

    Throws

    ApiError

    Parameters

    • __namedParameters: {
          body: MsgVpnCertMatchingRule;
          msgVpnName: string;
          opaquePassword?: string;
          ruleName: string;
          select?: string[];
          xContextId?: string;
      }
      • body: MsgVpnCertMatchingRule

        The Certificate Matching Rule object's attributes. *

      • msgVpnName: string

        The name of the Message VPN. *

      • Optional opaquePassword?: string

        Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the opaquePassword parameter. *

      • ruleName: string

        The name of the rule. *

      • Optional select?: string[]

        Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the select parameter. *

      • Optional xContextId?: string

        Optional context id the request is running. *

    Returns CancelablePromise<MsgVpnCertMatchingRuleResponse | SempMetaOnlyResponse>

  • Update a Certificate Matching Rule Attribute Filter object. Update a Certificate Matching Rule Attribute Filter object. Any attribute missing from the request will be left unchanged.

    A Cert Matching Rule Attribute Filter compares a username attribute to a string.

    Attribute Identifying Read-Only Write-Only Requires-Disable Deprecated Opaque
    filterName x x
    msgVpnName x x
    ruleName x x

    A SEMP client authorized with a minimum access scope/level of "global/read-write" is required to perform this operation.

    This has been available since 2.28.

    Returns

    MsgVpnCertMatchingRuleAttributeFilterResponse The Certificate Matching Rule Attribute Filter object's attributes after being updated, and the request metadata.

    Returns

    SempMetaOnlyResponse The error response.

    Throws

    ApiError

    Parameters

    • __namedParameters: {
          body: MsgVpnCertMatchingRuleAttributeFilter;
          filterName: string;
          msgVpnName: string;
          opaquePassword?: string;
          ruleName: string;
          select?: string[];
          xContextId?: string;
      }
      • body: MsgVpnCertMatchingRuleAttributeFilter

        The Certificate Matching Rule Attribute Filter object's attributes. *

      • filterName: string

        The name of the filter. *

      • msgVpnName: string

        The name of the Message VPN. *

      • Optional opaquePassword?: string

        Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the opaquePassword parameter. *

      • ruleName: string

        The name of the rule. *

      • Optional select?: string[]

        Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the select parameter. *

      • Optional xContextId?: string

        Optional context id the request is running. *

    Returns CancelablePromise<MsgVpnCertMatchingRuleAttributeFilterResponse | SempMetaOnlyResponse>