Update Open Id Provider Key

The description of the specified key entry can be updated. Attempt to modify any other field will result in a bad request error.

Request

URI

PUT

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

COPY

Path Parameters

string

openIdProviderKeyId

Required

OpenID Provider key URN

string

openIdProviderKeyId

Required

OpenID Provider key URN

Request Body

The updated OpenID Provider key.

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

200

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