Create Open Id Provider Key

Adds the provided private and public key pairs to the list of configured signing keys. This key is NOT automatically made the active signing key. The existing active key will continue to be used.

The provided keys, in addition to being of one of acceptable types, will be validated to confirm that they are a cryptographic pair and that they conform to the minimum key size in the SSL settings for the product.

Request

URI

POST

https://{api_host}/cloudapi/1.0.0/openIdProvider/keys

COPY

Request Body

openIdProviderKey of type(s) application/json

Required

{
    "id": "string",
    "description": "string",
    "creationDate": "string",
    "publicKey": "string",
    "privateKey": "string",
    "privateKeyPassphrase": "string"
}

string

Optional

A unique identifier for the key.

string

description

Optional

Description of the key.

string As date-time As date-time

creationDate

Optional

An ISO-8601 timestamp generated by the server when a key is added.

string

publicKey

Required

PEM encoded public key. All extraneous whitespace and other information is removed.

Only RSA and EC private keys are supported.

string

privateKey

Required

PEM encoded private key. All extraneous whitespace and other information is removed.

Only RSA and EC private keys are supported.

string

privateKeyPassphrase

Optional

passphrase for the private key. Required if the private key is encrypted.

Authentication

This operation uses the following authentication methods.

ApiKeyAuth

Responses

201

Created

Returns openIdProviderKey of type(s) application/json;version=38.0

{
    "id": "string",
    "description": "string",
    "creationDate": "string",
    "publicKey": "string",
    "privateKey": "string",
    "privateKeyPassphrase": "string"
}

string

Optional

A unique identifier for the key.

string

description

Optional

Description of the key.

string As date-time As date-time

creationDate

Optional

An ISO-8601 timestamp generated by the server when a key is added.

string