Jump to

• Request
• Response

Retrieve all config elements: SD.enforcement-profile

get

https://cloud-native-SBC-IP/config/v1/sd/enforcement-profile

Retrieve all config elements: SD.enforcement-profile

Request

Query Parameters

• revision-id: string
  Integer value of saved revision, or 'latest', 'active' to show the running config, or 'staging' to show complete configuration to be activated

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

return all config elements: EnforcementProfile

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object schema
  configure enforcement profiles

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

Nested Schema : schema

Type: object

configure enforcement profiles

Show Source

• _elementKey: string
  Read Only: true

  Identifier for the element or sub-element
• add-certificate-info: array add-certificate-info
  list of Certificate attributes to be inserted
• allowed-elements-profile: string
  Pattern: ^.*$

  name of the allowed-elements-profile
• allowed-methods: string
  list of allowed methods <INVITE, REGISTER, PRACK, OPTIONS, INFO, SUBSCRIBE, NOTIFY, REFER, UPDATE, MESSAGE, PUBLISH>
• certificate-ruri-check: boolean
  verify ruri against certificate attributes
• name(required): string
  Minimum Length: 1

  Pattern: ^[A-Za-z0-9_][A-Za-z0-9._\-]{0,127}$

  name of the enforcement profile
• sdp-address-check: boolean
  sdp address check

{
    "required":[
        "name"
    ],
    "properties":{
        "name":{
            "description":"name of the enforcement profile",
            "minLength":1,
            "pattern":"^[A-Za-z0-9_][A-Za-z0-9._\\-]{0,127}$",
            "type":"string"
        },
        "allowed-methods":{
            "description":"list of allowed methods <INVITE, REGISTER, PRACK, OPTIONS, INFO, SUBSCRIBE, NOTIFY, REFER, UPDATE, MESSAGE, PUBLISH>",
            "type":"string"
        },
        "sdp-address-check":{
            "description":"sdp address check",
            "type":"boolean"
        },
        "allowed-elements-profile":{
            "description":"name of the allowed-elements-profile",
            "pattern":"^.*$",
            "type":"string"
        },
        "add-certificate-info":{
            "description":"list of Certificate attributes to be inserted",
            "items":{
                "$ref":"#/components/schemas/CertAttrListConstraintEnum"
            },
            "type":"array"
        },
        "certificate-ruri-check":{
            "description":"verify ruri against certificate attributes",
            "type":"boolean"
        },
        "_elementKey":{
            "description":"Identifier for the element or sub-element",
            "readOnly":true,
            "type":"string"
        }
    },
    "description":"configure enforcement profiles",
    "type":"object"
}

Nested Schema : add-certificate-info

Type: array

list of Certificate attributes to be inserted

Show Source

• Array of: string
  Allowed Values: [ "sub-common-name", "sub-alt-name-DNS" ]

{
    "description":"list of Certificate attributes to be inserted",
    "items":{
        "$ref":"#/components/schemas/CertAttrListConstraintEnum"
    },
    "type":"array"
}

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"
}

Back to Top