Jump to

• Request
• Response

Retrieve all sub-elements: SD.realm-config.auth-attribute

get

https://cloud-native-SBC-IP/config/v1/sd/realm-config/{ElementKey}/auth-attribute

Retrieve all sub-elements: SD.realm-config.auth-attribute

Request

Path Parameters

• ElementKey: string
  Identifier for the element

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 sub elements: SipAuthAttribute

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object schema
  list of auth-attributes

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

Nested Schema : schema

Type: object

list of auth-attributes

Show Source

• _elementKey: string
  Read Only: true

  Identifier for the element or sub-element
• auth-realm(required): string
  Minimum Length: 1

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

  authentication realm
• auth-user-lookup(required): string
  Minimum Length: 1

  Lookup used for selecting the AuthUser
• in-dialog-methods: array in-dialog-methods
  in dialog methods to add authentication headers to
• password: string password
  authentication password
• passwordAsString: string
• username: string
  authentication username

{
    "required":[
        "auth-realm",
        "auth-user-lookup"
    ],
    "properties":{
        "auth-realm":{
            "description":"authentication realm",
            "minLength":1,
            "pattern":"^([A-Za-z0-9_][A-Za-z0-9._\\-]{0,127})?$",
            "type":"string"
        },
        "username":{
            "description":"authentication username",
            "type":"string"
        },
        "auth-user-lookup":{
            "description":"Lookup used for selecting the AuthUser",
            "minLength":1,
            "type":"string"
        },
        "password":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/SecureString"
                }
            ],
            "description":"authentication password",
            "type":"string"
        },
        "in-dialog-methods":{
            "description":"in dialog methods to add authentication headers to",
            "items":{
                "$ref":"#/components/schemas/SipMethodsConstraintEnum"
            },
            "type":"array"
        },
        "passwordAsString":{
            "type":"string"
        },
        "_elementKey":{
            "description":"Identifier for the element or sub-element",
            "readOnly":true,
            "type":"string"
        }
    },
    "description":"list of auth-attributes",
    "type":"object"
}

Nested Schema : in-dialog-methods

Type: array

in dialog methods to add authentication headers to

Show Source

• Array of: string
  Allowed Values: [ "INVITE", "ACK", "BYE", "CANCEL", "REGISTER", "OPTIONS", "PRACK", "SUBSCRIBE", "NOTIFY", "PUBLISH", "INFO", "REFER", "MESSAGE", "UPDATE" ]

{
    "description":"in dialog methods to add authentication headers to",
    "items":{
        "$ref":"#/components/schemas/SipMethodsConstraintEnum"
    },
    "type":"array"
}

Nested Schema : password

authentication password

Match All

authentication password

Show Source

• string(password)

{
    "allOf":[
        {
            "$ref":"#/components/schemas/SecureString"
        }
    ],
    "description":"authentication password",
    "type":"string"
}

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