Jump to

• Request
• Response

Create or replace client certificates

put

https://{your_site_interface}/opa-hub/api/12.2.35/clientCertificates

This operation will create or replace client certificates.

Request

There are no request parameters for this operation.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• items: array items

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/clientCertificatePut"
            }
        }
    },
    "additionalProperties":false
}

Nested Schema : items

Type: array

Show Source

• Array of: object clientCertificatePut

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

Nested Schema : clientCertificatePut

Type: object

Show Source

• name(required): string
  The certificate name.
• pemData(required): string (password)
  The PEM-formatted certificate and key data, starting with -----BEGIN CERTIFICATE----- and containing a -----BEGIN PRIVATE KEY-----. Write-only property.

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"The certificate name."
        },
        "pemData":{
            "type":"string",
            "format":"password",
            "description":"The PEM-formatted certificate and key data, starting with -----BEGIN CERTIFICATE----- and containing a -----BEGIN PRIVATE KEY-----. Write-only property.",
            "writeOnly":true
        }
    },
    "additionalProperties":false,
    "required":[
        "pemData",
        "name"
    ]
}

Security

• Authorization: apiKey
  Type: apiKey

  Description: Obtain a bearer token from https://{your_site_interface}/opa-hub/api/12.2.17/auth and use it in the Authorization header as: Bearer {token}.
• oauth2_opa: oauth2
  Type: oauth2

  Description: POST the OAuth2 Client Credentials parameters to https://{your_site_interface}/opa-hub/api/12.2.17/auth and use the access token from the response in the Authorization header.

Back to Top

Response

Supported Media Types

• application/json

201 Response

The request has been fulfilled and resulted in a new resource being created.

Body ()

Root Schema : clientCertificates

Type: object

Show Source

• items: array items

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/clientCertificate"
            }
        }
    },
    "additionalProperties":false
}

Nested Schema : items

Type: array

Show Source

• Array of: object clientCertificate

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

Nested Schema : clientCertificate

Type: object

Show Source

• fingerprintSHA1: string
  Read Only: true

  The certificate SHA-1 fingerprint.
• fingerprintSHA256: string
  Read Only: true

  The certificate SHA-256 fingerprint.
• issuer: string
  Read Only: true

  The distinguished name of the certificate issuer.
• name(required): string
  The certificate name.
• references: integer (int64)
  Read Only: true

  The number of references to this certificate.
• subject: string
  Read Only: true

  The distinguished name of the certificate subject.
• validFrom: string (date-time)
  Read Only: true

  The date and time this certificate is valid from.
• validTo: string (date-time)
  Read Only: true

  The date and time this certificate is valid to.

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"The certificate name."
        },
        "fingerprintSHA256":{
            "type":"string",
            "description":"The certificate SHA-256 fingerprint.",
            "readOnly":true
        },
        "fingerprintSHA1":{
            "type":"string",
            "description":"The certificate SHA-1 fingerprint.",
            "readOnly":true
        },
        "validFrom":{
            "type":"string",
            "format":"date-time",
            "description":"The date and time this certificate is valid from.",
            "readOnly":true
        },
        "validTo":{
            "type":"string",
            "format":"date-time",
            "description":"The date and time this certificate is valid to.",
            "readOnly":true
        },
        "issuer":{
            "type":"string",
            "description":"The distinguished name of the certificate issuer.",
            "readOnly":true
        },
        "subject":{
            "type":"string",
            "description":"The distinguished name of the certificate subject.",
            "readOnly":true
        },
        "references":{
            "type":"integer",
            "format":"int64",
            "description":"The number of references to this certificate.",
            "readOnly":true
        }
    },
    "additionalProperties":false,
    "required":[
        "name"
    ]
}

400 Response

The request could not be processed because it contains missing or invalid information.

409 Response

A duplicate name or certificate is already present.

Back to Top