Generate CSR

POST 
/v2/config/digital-wallet/openid/key-management/keys/:keyId/csr

Generates a Certificate Signing Request (CSR) for a key in the secure vault. Send the CSR to a Certificate Authority, then upload the signed certificate chain with the upload certificate chain operation.

Request

Path Parameters

keyId stringrequired

Unique identifier of the key

Header Parameters

X-SandboxOrgId stringrequired
Optional. Unique identifier of the sandbox organisation to use for this request. When you send this header, the service runs the operation in the context of the named sandbox organisation, that is, against the wallet of that sandbox organisation and not against the main wallet of the organisation. Leave the header out to use the main wallet.
The service reads this header only when you authenticate with a bearer access token. When you authenticate with an API key, the service takes the sandbox organisation from the API key and ignores this header. To run an API-key call in a sandbox organisation, bind the key to the sandbox organisation with PUT /v2/config/admin/apikey/{apiKeyId}/sandbox-org instead.
X-SubwalletId is the deprecated name of this header. The service continues to accept it, but X-SandboxOrgId wins if you send both headers.
The sandbox organisation must exist, must belong to your organisation and must be deployed. An unknown identifier, an identifier of a sandbox organisation that is not deployed, and an identifier that belongs to a different organisation all make the call fail with HTTP 400.
Example: 6889e1a4c5b2f30001a3d710

application/json

Body

required

Subject and Subject Alternative Name (SAN) data for the CSR.

commonName stringrequired

Common name (CN) of the certificate subject. Use the organisation name or the service name.

organization string

Organisation (O) of the certificate subject. Optional.

country string

Two letter country code (C) of the certificate subject. Optional.

sanDns string[]

DNS entries for the Subject Alternative Name (SAN) extension. Optional.

sanUri string[]

URI entries for the Subject Alternative Name (SAN) extension. Optional.

Responses

200

CSR generated successfully.

Response Headers

application/json

Schema

Schema

csr stringrequired

Certificate Signing Request in PEM format.

Example (from schema)

{
  "csr": "-----BEGIN CERTIFICATE REQUEST-----\n<base64-csr-content>\n-----END CERTIFICATE REQUEST-----\n"
}

400

The key ID is missing, the key does not exist, or the request body is not valid.

Response Headers

application/json

Schema

Schema

errorCode integerrequired
errorDescription stringrequired

Example (from schema)

{
  "errorCode": 400,
  "errorDescription": "Bad input parameter"
}

401

Unauthorized

Response Headers

application/json

Schema

Schema

errorCode integerrequired
errorDescription stringrequired

Example (from schema)

{
  "errorCode": 400,
  "errorDescription": "Bad input parameter"
}

500

Internal server error

Response Headers

application/json

Schema

Schema

errorCode integerrequired
errorDescription stringrequired

Example (from schema)

{
  "errorCode": 400,
  "errorDescription": "Bad input parameter"
}

Loading...