Jump to

• Request
• Response

Create hub certificates

post

https://{your_site_interface}/opa-hub/api/12.2.40/hubCertificates

This operation will create one or more hub 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/hubCertificatePost"
            }
        }
    },
    "additionalProperties":false
}

Nested Schema : items

Type: array

Show Source

• Array of: object hubCertificatePost

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

Nested Schema : hubCertificatePost

Type: object

Show Source

• keyId(required): string
  The key id
• privateKeyPemData(required): string
  The private key details
• x5cPemData(required): string
  The certificate details

{
    "type":"object",
    "properties":{
        "keyId":{
            "type":"string",
            "description":"The key id",
            "writeOnly":true
        },
        "privateKeyPemData":{
            "type":"string",
            "description":"The private key details",
            "writeOnly":true
        },
        "x5cPemData":{
            "type":"string",
            "description":"The certificate details",
            "writeOnly":true
        }
    },
    "additionalProperties":false,
    "required":[
        "x5cPemData",
        "keyId",
        "privateKeyPemData"
    ]
}

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 : hubCertificates

Type: object

Show Source

• items: array items

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

Nested Schema : items

Type: array

Show Source

• Array of: object hubCertificate

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

Nested Schema : hubCertificate

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.
• keys: array keys
  Read Only: true
• kid: string
  Read Only: true

  The key id
• lastUpdated: string (date-time)
  This indicates the last updated time of the certificate
• status: boolean
  The hub key status indicator
• 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":{
        "kid":{
            "type":"string",
            "description":"The key id",
            "readOnly":true
        },
        "status":{
            "type":"boolean",
            "description":"The hub key status indicator"
        },
        "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
        },
        "lastUpdated":{
            "type":"string",
            "format":"date-time",
            "description":"This indicates the last updated time of the certificate"
        },
        "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
        },
        "keys":{
            "type":"array",
            "readOnly":true,
            "items":{
                "$ref":"#/components/schemas/hubCertificateKey"
            }
        }
    },
    "additionalProperties":false
}

Nested Schema : keys

Type: array

Read Only: true

Show Source

• Array of: object hubCertificateKey

{
    "type":"array",
    "readOnly":true,
    "items":{
        "$ref":"#/components/schemas/hubCertificateKey"
    }
}

Nested Schema : hubCertificateKey

Type: object

Show Source

• e: string
  key public exponent
• kid: string
  key unique id
• kty: string
  key type
• n: string
  key modulus
• use: string
  key use
• x5c: array x5c
  certificate of the key

{
    "type":"object",
    "properties":{
        "kty":{
            "type":"string",
            "description":"key type"
        },
        "e":{
            "type":"string",
            "description":"key public exponent"
        },
        "use":{
            "type":"string",
            "description":"key use"
        },
        "n":{
            "type":"string",
            "description":"key modulus"
        },
        "kid":{
            "type":"string",
            "description":"key unique id"
        },
        "x5c":{
            "type":"array",
            "description":"certificate of the key",
            "items":{
                "type":"string"
            }
        }
    },
    "additionalProperties":false
}

Nested Schema : x5c

Type: array

certificate of the key

Show Source

• Array of: string

{
    "type":"array",
    "description":"certificate of the key",
    "items":{
        "type":"string"
    }
}

400 Response

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

409 Response

The request could not be completed due to a conflict with the current state of the resource.

Back to Top