Jump to

• Request
• Response

Add a new config element: SD.sti-config

post

https://cloud-native-SBC-IP/config/v1/sd/sti-config

Add a new config element: SD.sti-config

Request

There are no request parameters for this operation.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

configure global parameters for STIR/SHAKEN

Show Source

• _elementKey: string
  Read Only: true

  Identifier for the element or sub-element
• anonymous-uri-add-verstat-to-hostpart: boolean
  When enabled, if an INVITE lacks PAI headers but has a Privacy header and an anonymous From URI (e.g., sip:[e-mail]), the verstat parameter is added after the URI's host part.
• check-duplicate-passports: boolean
  If enabled, the cnSBC checks for duplicate SHAKEN and DIV PASSPoRT in the received INVITE and removes duplicates from the outgoing INVITE.
• circuit-breaker-error-threshold: integer (int32)
  Minimum Value: 3

  Maximum Value: 10

  circuit breaker error threshold
• circuit-breaker-half-open-frequency: integer (int32)
  Minimum Value: 5

  Maximum Value: 100

  circuit breaker send frequency during half-open state (i.e. send every n requests)
• circuit-breaker-retry-time: integer (int32)
  Minimum Value: 5

  Maximum Value: 900

  circuit breaker retry time (in seconds)
• circuit-breaker-window-duration: integer (int32)
  Minimum Value: 10

  Maximum Value: 30

  circuit breaker window duration (in seconds)
• dest-comparison: string
  Allowed Values: [ "Request-URI", "To" ]
• flip-tn-lookup-order: boolean
  If enabled, when TNs are in both From and PAI headers, the From header takes priority for the orig SHAKEN PASSPORT claim and verstat parameter from STI-VS.
• max-retry-attempts: integer (int32)
  Minimum Value: 0

  Maximum Value: 30

  If the selected STIR server times out or doesn't respond, another server from the STI server group is chosen. The cnSBC retries until a response is received or the max-retry-attempts limit is reached
• reason-json-sip-translation: boolean
  If enabled, a 'Reason' header is added to the SIP egress INVITE when the STI-VS Server's HTTP response contains a reasoncode/reasontext (ATIS) or status-code/reason-phrase (4xx/5xx for 3GPP).
• sti-as-correlation-id: boolean
  If enabled, a new parameter, 'SipCallId,' containing the 'corrID' from the 'P-NokiaSiemens.Session-Info' SIP header, will be added in the request to STI-AS.
• sti-header-mapping-ruleset-name: string
  name of the instance of sti-header-mapping-ruleset
• sti-response-treatment-config-name: string
  When configured with a valid 'sti-response-treatment-config' name, it applies to all STI servers and to a specific server if its 'sti-response-treatment-config-name' is non empty.
• sti-signaling-attest-info-mandatory: boolean
  Retrieve attestation value and OrigId from SIP headers only
• tn-retargeting: boolean
  If enabled, the cnSBC sends a DIV authentication request based on the received INVITE for 3GPP configuration.
• use-identity-header: boolean
  If enabled, sends a Reason header in 18x, 19x, and final responses to the originator with a cause value of 428 and the text 'Use Identity Header'.
• verstat-comparison: string
  It can be empty or a comma-separated list of verstat values. If non-empty, the cnSBC compares the verstat value in the FROM and PAI headers with the verstat-comparison values.

{
    "properties":{
        "circuit-breaker-window-duration":{
            "description":"circuit breaker window duration (in seconds)",
            "format":"int32",
            "maximum":30,
            "minimum":10,
            "type":"integer"
        },
        "circuit-breaker-error-threshold":{
            "description":"circuit breaker error threshold",
            "format":"int32",
            "maximum":10,
            "minimum":3,
            "type":"integer"
        },
        "circuit-breaker-retry-time":{
            "description":"circuit breaker retry time (in seconds)",
            "format":"int32",
            "maximum":900,
            "minimum":5,
            "type":"integer"
        },
        "circuit-breaker-half-open-frequency":{
            "description":"circuit breaker send frequency during half-open state (i.e. send every n requests)",
            "format":"int32",
            "maximum":100,
            "minimum":5,
            "type":"integer"
        },
        "sti-signaling-attest-info-mandatory":{
            "description":"Retrieve attestation value and OrigId from SIP headers only",
            "type":"boolean"
        },
        "anonymous-uri-add-verstat-to-hostpart":{
            "description":"When enabled, if an INVITE lacks PAI headers but has a Privacy header and an anonymous From URI (e.g., sip:[e-mail]), the verstat parameter is added after the URI's host part.",
            "type":"boolean"
        },
        "use-identity-header":{
            "description":"If enabled, sends a Reason header in 18x, 19x, and final responses to the originator with a cause value of 428 and the text 'Use Identity Header'.",
            "type":"boolean"
        },
        "check-duplicate-passports":{
            "description":"If enabled, the cnSBC checks for duplicate SHAKEN and DIV PASSPoRT in the received INVITE and removes duplicates from the outgoing INVITE.",
            "type":"boolean"
        },
        "tn-retargeting":{
            "description":"If enabled, the cnSBC sends a DIV authentication request based on the received INVITE for 3GPP configuration.",
            "type":"boolean"
        },
        "verstat-comparison":{
            "description":"It can be empty or a comma-separated list of verstat values. If non-empty, the cnSBC compares the verstat value in the FROM and PAI headers with the verstat-comparison values.",
            "type":"string"
        },
        "dest-comparison":{
            "$ref":"#/components/schemas/StirShakenDestComparisonConstraintEnum"
        },
        "sti-as-correlation-id":{
            "description":"If enabled, a new parameter, 'SipCallId,' containing the 'corrID' from the 'P-NokiaSiemens.Session-Info' SIP header, will be added in the request to STI-AS.",
            "type":"boolean"
        },
        "reason-json-sip-translation":{
            "description":"If enabled, a 'Reason' header is added to the SIP egress INVITE when the STI-VS Server's HTTP response contains a reasoncode/reasontext (ATIS) or status-code/reason-phrase (4xx/5xx for 3GPP).",
            "type":"boolean"
        },
        "sti-header-mapping-ruleset-name":{
            "description":"name of the instance of sti-header-mapping-ruleset",
            "type":"string"
        },
        "flip-tn-lookup-order":{
            "description":"If enabled, when TNs are in both From and PAI headers, the From header takes priority for the orig SHAKEN PASSPORT claim and verstat parameter from STI-VS.",
            "type":"boolean"
        },
        "sti-response-treatment-config-name":{
            "description":"When configured with a valid 'sti-response-treatment-config' name, it applies to all STI servers and to a specific server if its 'sti-response-treatment-config-name' is non empty.",
            "type":"string"
        },
        "max-retry-attempts":{
            "description":"If the selected STIR server times out or doesn't respond, another server from the STI server group is chosen. The cnSBC retries until a response is received or the max-retry-attempts limit is reached",
            "format":"int32",
            "maximum":30,
            "minimum":0,
            "type":"integer"
        },
        "_elementKey":{
            "description":"Identifier for the element or sub-element",
            "readOnly":true,
            "type":"string"
        }
    },
    "description":"configure global parameters for STIR/SHAKEN",
    "type":"object"
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

return config element: StiConfig

Body ()

Root Schema : schema

Type: object

configure global parameters for STIR/SHAKEN

Show Source

• _elementKey: string
  Read Only: true

  Identifier for the element or sub-element
• anonymous-uri-add-verstat-to-hostpart: boolean
  When enabled, if an INVITE lacks PAI headers but has a Privacy header and an anonymous From URI (e.g., sip:[e-mail]), the verstat parameter is added after the URI's host part.
• check-duplicate-passports: boolean
  If enabled, the cnSBC checks for duplicate SHAKEN and DIV PASSPoRT in the received INVITE and removes duplicates from the outgoing INVITE.
• circuit-breaker-error-threshold: integer (int32)
  Minimum Value: 3

  Maximum Value: 10

  circuit breaker error threshold
• circuit-breaker-half-open-frequency: integer (int32)
  Minimum Value: 5

  Maximum Value: 100

  circuit breaker send frequency during half-open state (i.e. send every n requests)
• circuit-breaker-retry-time: integer (int32)
  Minimum Value: 5

  Maximum Value: 900

  circuit breaker retry time (in seconds)
• circuit-breaker-window-duration: integer (int32)
  Minimum Value: 10

  Maximum Value: 30

  circuit breaker window duration (in seconds)
• dest-comparison: string
  Allowed Values: [ "Request-URI", "To" ]
• flip-tn-lookup-order: boolean
  If enabled, when TNs are in both From and PAI headers, the From header takes priority for the orig SHAKEN PASSPORT claim and verstat parameter from STI-VS.
• max-retry-attempts: integer (int32)
  Minimum Value: 0

  Maximum Value: 30

  If the selected STIR server times out or doesn't respond, another server from the STI server group is chosen. The cnSBC retries until a response is received or the max-retry-attempts limit is reached
• reason-json-sip-translation: boolean
  If enabled, a 'Reason' header is added to the SIP egress INVITE when the STI-VS Server's HTTP response contains a reasoncode/reasontext (ATIS) or status-code/reason-phrase (4xx/5xx for 3GPP).
• sti-as-correlation-id: boolean
  If enabled, a new parameter, 'SipCallId,' containing the 'corrID' from the 'P-NokiaSiemens.Session-Info' SIP header, will be added in the request to STI-AS.
• sti-header-mapping-ruleset-name: string
  name of the instance of sti-header-mapping-ruleset
• sti-response-treatment-config-name: string
  When configured with a valid 'sti-response-treatment-config' name, it applies to all STI servers and to a specific server if its 'sti-response-treatment-config-name' is non empty.
• sti-signaling-attest-info-mandatory: boolean
  Retrieve attestation value and OrigId from SIP headers only
• tn-retargeting: boolean
  If enabled, the cnSBC sends a DIV authentication request based on the received INVITE for 3GPP configuration.
• use-identity-header: boolean
  If enabled, sends a Reason header in 18x, 19x, and final responses to the originator with a cause value of 428 and the text 'Use Identity Header'.
• verstat-comparison: string
  It can be empty or a comma-separated list of verstat values. If non-empty, the cnSBC compares the verstat value in the FROM and PAI headers with the verstat-comparison values.

{
    "properties":{
        "circuit-breaker-window-duration":{
            "description":"circuit breaker window duration (in seconds)",
            "format":"int32",
            "maximum":30,
            "minimum":10,
            "type":"integer"
        },
        "circuit-breaker-error-threshold":{
            "description":"circuit breaker error threshold",
            "format":"int32",
            "maximum":10,
            "minimum":3,
            "type":"integer"
        },
        "circuit-breaker-retry-time":{
            "description":"circuit breaker retry time (in seconds)",
            "format":"int32",
            "maximum":900,
            "minimum":5,
            "type":"integer"
        },
        "circuit-breaker-half-open-frequency":{
            "description":"circuit breaker send frequency during half-open state (i.e. send every n requests)",
            "format":"int32",
            "maximum":100,
            "minimum":5,
            "type":"integer"
        },
        "sti-signaling-attest-info-mandatory":{
            "description":"Retrieve attestation value and OrigId from SIP headers only",
            "type":"boolean"
        },
        "anonymous-uri-add-verstat-to-hostpart":{
            "description":"When enabled, if an INVITE lacks PAI headers but has a Privacy header and an anonymous From URI (e.g., sip:[e-mail]), the verstat parameter is added after the URI's host part.",
            "type":"boolean"
        },
        "use-identity-header":{
            "description":"If enabled, sends a Reason header in 18x, 19x, and final responses to the originator with a cause value of 428 and the text 'Use Identity Header'.",
            "type":"boolean"
        },
        "check-duplicate-passports":{
            "description":"If enabled, the cnSBC checks for duplicate SHAKEN and DIV PASSPoRT in the received INVITE and removes duplicates from the outgoing INVITE.",
            "type":"boolean"
        },
        "tn-retargeting":{
            "description":"If enabled, the cnSBC sends a DIV authentication request based on the received INVITE for 3GPP configuration.",
            "type":"boolean"
        },
        "verstat-comparison":{
            "description":"It can be empty or a comma-separated list of verstat values. If non-empty, the cnSBC compares the verstat value in the FROM and PAI headers with the verstat-comparison values.",
            "type":"string"
        },
        "dest-comparison":{
            "$ref":"#/components/schemas/StirShakenDestComparisonConstraintEnum"
        },
        "sti-as-correlation-id":{
            "description":"If enabled, a new parameter, 'SipCallId,' containing the 'corrID' from the 'P-NokiaSiemens.Session-Info' SIP header, will be added in the request to STI-AS.",
            "type":"boolean"
        },
        "reason-json-sip-translation":{
            "description":"If enabled, a 'Reason' header is added to the SIP egress INVITE when the STI-VS Server's HTTP response contains a reasoncode/reasontext (ATIS) or status-code/reason-phrase (4xx/5xx for 3GPP).",
            "type":"boolean"
        },
        "sti-header-mapping-ruleset-name":{
            "description":"name of the instance of sti-header-mapping-ruleset",
            "type":"string"
        },
        "flip-tn-lookup-order":{
            "description":"If enabled, when TNs are in both From and PAI headers, the From header takes priority for the orig SHAKEN PASSPORT claim and verstat parameter from STI-VS.",
            "type":"boolean"
        },
        "sti-response-treatment-config-name":{
            "description":"When configured with a valid 'sti-response-treatment-config' name, it applies to all STI servers and to a specific server if its 'sti-response-treatment-config-name' is non empty.",
            "type":"string"
        },
        "max-retry-attempts":{
            "description":"If the selected STIR server times out or doesn't respond, another server from the STI server group is chosen. The cnSBC retries until a response is received or the max-retry-attempts limit is reached",
            "format":"int32",
            "maximum":30,
            "minimum":0,
            "type":"integer"
        },
        "_elementKey":{
            "description":"Identifier for the element or sub-element",
            "readOnly":true,
            "type":"string"
        }
    },
    "description":"configure global parameters for STIR/SHAKEN",
    "type":"object"
}

404 Response

Not Found

Body ()

Root Schema : ApiValidationError

Type: object

Show Source

• _elementKey: string
  Read Only: true

  Identifier for the element or sub-element
• code: string
• errors: array errors
• message: string
• timestamp: string

{
    "properties":{
        "timestamp":{
            "type":"string"
        },
        "code":{
            "type":"string"
        },
        "message":{
            "type":"string"
        },
        "errors":{
            "items":{
                "$ref":"#/components/schemas/Errors"
            },
            "type":"array"
        },
        "_elementKey":{
            "description":"Identifier for the element or sub-element",
            "readOnly":true,
            "type":"string"
        }
    },
    "type":"object"
}

Nested Schema : errors

Type: array

Show Source

• Array of: object Errors

{
    "items":{
        "$ref":"#/components/schemas/Errors"
    },
    "type":"array"
}

Nested Schema : Errors

Type: object

Show Source

• _elementKey: string
  Read Only: true

  Identifier for the element or sub-element
• attribute: string
• code: string
• message: string
• type: string
  Allowed Values: [ "error", "fatal", "warn" ]

{
    "properties":{
        "attribute":{
            "type":"string"
        },
        "type":{
            "$ref":"#/components/schemas/TypeEnum"
        },
        "message":{
            "type":"string"
        },
        "code":{
            "type":"string"
        },
        "_elementKey":{
            "description":"Identifier for the element or sub-element",
            "readOnly":true,
            "type":"string"
        }
    },
    "type":"object"
}

406 Response

Validation Failure

Body ()

Root Schema : ApiValidationError

Type: object

Show Source

• _elementKey: string
  Read Only: true

  Identifier for the element or sub-element
• code: string
• errors: array errors
• message: string
• timestamp: string

{
    "properties":{
        "timestamp":{
            "type":"string"
        },
        "code":{
            "type":"string"
        },
        "message":{
            "type":"string"
        },
        "errors":{
            "items":{
                "$ref":"#/components/schemas/Errors"
            },
            "type":"array"
        },
        "_elementKey":{
            "description":"Identifier for the element or sub-element",
            "readOnly":true,
            "type":"string"
        }
    },
    "type":"object"
}

Nested Schema : errors

Type: array

Show Source

• Array of: object Errors

{
    "items":{
        "$ref":"#/components/schemas/Errors"
    },
    "type":"array"
}

Nested Schema : Errors

Type: object

Show Source

• _elementKey: string
  Read Only: true

  Identifier for the element or sub-element
• attribute: string
• code: string
• message: string
• type: string
  Allowed Values: [ "error", "fatal", "warn" ]

{
    "properties":{
        "attribute":{
            "type":"string"
        },
        "type":{
            "$ref":"#/components/schemas/TypeEnum"
        },
        "message":{
            "type":"string"
        },
        "code":{
            "type":"string"
        },
        "_elementKey":{
            "description":"Identifier for the element or sub-element",
            "readOnly":true,
            "type":"string"
        }
    },
    "type":"object"
}

Back to Top