Jump to

• Request
• Response

Retrieve ca certificate details

get

https://cloud-native-SBC-IP/config/v1/certificates/ca-certs/{name}

Retrieve ca certificate details

Request

Path Parameters

• name: string

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK

Body ()

Root Schema : CertificateDetail

Type: object

Show Source

• extension: object Extensions
• friendly-name: string
• issuer: array issuer
• public-key-info: object PublicKeyInfo
• serial-number: string
• signature-algorithm: string
• signature-hash-algorithm: string
• subject: array subject
• thumb-print: string
• valid-from: string (date)
  Example: 2022-03-10
• valid-to: string (date)
  Example: 2022-03-10
• version: integer (int32)

{
    "properties":{
        "version":{
            "format":"int32",
            "type":"integer"
        },
        "serial-number":{
            "type":"string"
        },
        "signature-algorithm":{
            "type":"string"
        },
        "signature-hash-algorithm":{
            "type":"string"
        },
        "issuer":{
            "items":{
                "type":"string"
            },
            "type":"array"
        },
        "valid-from":{
            "example":"2022-03-10",
            "format":"date",
            "type":"string"
        },
        "valid-to":{
            "example":"2022-03-10",
            "format":"date",
            "type":"string"
        },
        "subject":{
            "items":{
                "type":"string"
            },
            "type":"array"
        },
        "public-key-info":{
            "$ref":"#/components/schemas/PublicKeyInfo"
        },
        "extension":{
            "$ref":"#/components/schemas/Extensions"
        },
        "friendly-name":{
            "type":"string"
        },
        "thumb-print":{
            "type":"string"
        }
    },
    "type":"object"
}

Nested Schema : Extensions

Type: object

Show Source

• authority-info-access: array authority-info-access
• authority-key-identifier: string
• basic-constraints: string
• certificate-policies: object CertificatePolicy
• crl-distribution-points: object CrlDistributionPoint
• crlDistributionPoint: object CrlDistributionPoint
• extended-key-usage: array extended-key-usage
• extended-validation: string
• key-usage: array key-usage
• subject-alternative-name: array subject-alternative-name
• subject-key-identifier: string

{
    "properties":{
        "subject-key-identifier":{
            "type":"string"
        },
        "authority-key-identifier":{
            "type":"string"
        },
        "basic-constraints":{
            "type":"string"
        },
        "subject-alternative-name":{
            "items":{
                "type":"string"
            },
            "type":"array"
        },
        "key-usage":{
            "items":{
                "type":"string"
            },
            "type":"array"
        },
        "certificate-policies":{
            "$ref":"#/components/schemas/CertificatePolicy"
        },
        "crlDistributionPoint":{
            "$ref":"#/components/schemas/CrlDistributionPoint"
        },
        "extended-key-usage":{
            "items":{
                "type":"string"
            },
            "type":"array"
        },
        "extended-validation":{
            "type":"string"
        },
        "authority-info-access":{
            "items":{
                "type":"string"
            },
            "type":"array"
        },
        "crl-distribution-points":{
            "$ref":"#/components/schemas/CrlDistributionPoint"
        }
    },
    "type":"object"
}

Nested Schema : issuer

Type: array

Show Source

• Array of: string

{
    "items":{
        "type":"string"
    },
    "type":"array"
}

Nested Schema : PublicKeyInfo

Type: object

Show Source

• public-key: string
• public-key-algorithm: string
• public-key-parameter: string

{
    "properties":{
        "public-key":{
            "type":"string"
        },
        "public-key-parameter":{
            "type":"string"
        },
        "public-key-algorithm":{
            "type":"string"
        }
    },
    "type":"object"
}

Nested Schema : subject

Type: array

Show Source

• Array of: string

{
    "items":{
        "type":"string"
    },
    "type":"array"
}

Nested Schema : authority-info-access

Type: array

Show Source

• Array of: string

{
    "items":{
        "type":"string"
    },
    "type":"array"
}

Nested Schema : CertificatePolicy

Type: object

Show Source

• policyQualifiers: array policyQualifiers

{
    "properties":{
        "policyQualifiers":{
            "items":{
                "$ref":"#/components/schemas/PolicyQualifiers"
            },
            "type":"array"
        }
    },
    "type":"object"
}

Nested Schema : CrlDistributionPoint

Type: object

Show Source

• distributionPointFullName: object DistributionPointFullName

{
    "properties":{
        "distributionPointFullName":{
            "$ref":"#/components/schemas/DistributionPointFullName"
        }
    },
    "type":"object"
}

Nested Schema : extended-key-usage

Type: array

Show Source

• Array of: string

{
    "items":{
        "type":"string"
    },
    "type":"array"
}

Nested Schema : key-usage

Type: array

Show Source

• Array of: string

{
    "items":{
        "type":"string"
    },
    "type":"array"
}

Nested Schema : subject-alternative-name

Type: array

Show Source

• Array of: string

{
    "items":{
        "type":"string"
    },
    "type":"array"
}

Nested Schema : policyQualifiers

Type: array

Show Source

• Array of: object PolicyQualifiers

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

Nested Schema : PolicyQualifiers

Type: object

Show Source

• qualifier: string
• qualifierID: string

{
    "properties":{
        "qualifierID":{
            "type":"string"
        },
        "qualifier":{
            "type":"string"
        }
    },
    "type":"object"
}

Nested Schema : DistributionPointFullName

Type: object

Show Source

• uri: string

{
    "properties":{
        "uri":{
            "type":"string"
        }
    },
    "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

Not Acceptable

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