Jump to

• Request
• Response

Retrieve one config element: SD.authentication-profile

get

https://cloud-native-SBC-IP/config/v1/sd/authentication-profile/{ElementKey}

Retrieve one config element: SD.authentication-profile

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 one config element: AuthenticationProfile

Body ()

Root Schema : schema

Type: object

configure authentication profile

Show Source

• _elementKey: string
  Read Only: true

  Identifier for the element or sub-element
• authentication-scheme: string
  Allowed Values: [ "bearer" ]
• name(required): string
  Minimum Length: 1

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

  name of authentication profile
• preshared-key: string preshared-key
  authentication password
• presharedKeyAsString: string

{
    "required":[
        "name"
    ],
    "properties":{
        "name":{
            "description":"name of authentication profile",
            "minLength":1,
            "pattern":"^[A-Za-z0-9_][A-Za-z0-9._\\-]{0,127}$",
            "type":"string"
        },
        "authentication-scheme":{
            "$ref":"#/components/schemas/AuthenticationSchemeEnum"
        },
        "preshared-key":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/SecureString"
                }
            ],
            "description":"authentication password",
            "type":"string"
        },
        "presharedKeyAsString":{
            "type":"string"
        },
        "_elementKey":{
            "description":"Identifier for the element or sub-element",
            "readOnly":true,
            "type":"string"
        }
    },
    "description":"configure authentication profile",
    "type":"object"
}

Nested Schema : preshared-key

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