Certificate



[tags: Certificate,Certificates, csr]

Resource Root

https://localhost:8443/api/rest/pki//certificates

Summary


Resources Methods
https://localhost:8443/api/rest/pki//certificates

GET  Query for a certificate with a given alias.

GET Get details in text for all certificates.

https://localhost:8443/api/rest/pki/certificates/selfsigned

POST  Regenerate RPRM self signed certificate.

https://localhost:8443/api/rest/pki//certificates/trusted

GET Get details in text about all trust anchors.

POST Install a trust anchor by uploading encoded certificate material.

POST Install a trust anchor by uploading bytes.

https://localhost:8443/api/rest/pki//certificates/trusted/{alias}

DELETE .

GET Get trust anchor by alias.

https://localhost:8443/api/rest/pki//certificates/trusted/{alias}/download

GET .

https://localhost:8443/api/rest/pki//certificates/identity

GET List all identity certificates.

POST Install a new identity certificate by uploading certificate or chain and private key.

POST Install a new identity certificate by uploading encoded certificate or chain.

POST Install a new identity certificate by uploading certificate or chain bytes.

https://localhost:8443/api/rest/pki//certificates/identity/{alias}

DELETE .

GET Get details of current identity certificate in text.

https://localhost:8443/api/rest/pki//certificates/identity/{alias}/download

GET .

GET Download of identity certificate of given alias in pkcs12 format.

https://localhost:8443/api/rest/pki//csrs

GET  Get a list of all certificate signing requests .

POST Create a new certificate signing request.

https://localhost:8443/api/rest/pki//csrs/{alias}

DELETE Delete a csr with given alias.

https://localhost:8443/api/rest/pki//csrs/{csrId}

GET .

GET Get a csr given an alias.

https://localhost:8443/api/rest/pki//csrs/{csrId}/download

GET .

Resources


https://localhost:8443/api/rest/pki//certificates


Methods

GET

Query for a certificate with a given alias

Request

Query Parameters

Name Type Description
alias xs:string

Response

Status Representation Description
200 application/vnd.plcm.plcm-certificate-info+xml
application/vnd.plcm.plcm-certificate-info+json
application/xml
application/json
Found a certificate with given alias
404 text/plain
Could not find a certificate with given alias
406 text/plain
Unacceptable. Invalid accept header

GET

Get details in text for all certificates

Request

Response

Status Representation Description
200 application/vnd.plcm.plcm-certificate-info-list+xml
application/xml
text/xml
application/vnd.plcm.plcm-certificate-info-list+json
application/json
406 text/plain
Unacceptable. Invalid accept header

https://localhost:8443/api/rest/pki/certificates/selfsigned


Methods

POST

Regenerate RPRM self signed certificate.
[tags: RPRM_INTERNAL]

Response

Status Representation Description
204 The self signed certificate is successful regenerated.
401 application/vnd.plcm.plcm-error+xml
Invalid credentials.
403 application/vnd.plcm.plcm-error+xml
Unable to get permission. regenerate self signed certificate requires administrator role.

https://localhost:8443/api/rest/pki//certificates/trusted


Methods

GET

Get details in text about all trust anchors

Request

Response

Status Representation Description
200 application/vnd.plcm.plcm-certificate-info-list+xml
application/xml
text/xml
application/vnd.plcm.plcm-certificate-info-list+json
application/json
406 text/plain
Unacceptable. Invalid accept header

POST

Install a trust anchor by uploading encoded certificate material

Request

Representations

application/vnd.plcm.plcm-certificate-material+xml
application/vnd.plcm.plcm-certificate-material+json

Response

Status Representation Description
201 text/plain
406 text/plain
Unacceptable. Invalid content-type header
400 application/vnd.plcm.plcm-error+xml
Bad request. Request data is not correct.

POST

Install a trust anchor by uploading bytes

Request

Representations

application/octet-stream

Response

Status Representation Description
201 text/plain
406 text/plain
Unacceptable. Invalid content-type header
400 application/vnd.plcm.plcm-error+xml
Bad request. Request data is not correct.

https://localhost:8443/api/rest/pki//certificates/trusted/{alias}


Template Parameters

Name Type Description
alias xs:string

Methods

DELETE

Request

Response

Status Representation Description
204 Successfully deleted trust anchor
400 application/vnd.plcm.plcm-error+xml
Bad request. Bad alias.
404 application/vnd.plcm.plcm-error+xml
Requested resource could not be found

GET

Get trust anchor by alias

Request

Response

Status Representation Description
200 application/vnd.plcm.plcm-certificate-info+xml
application/vnd.plcm.plcm-certificate-info+json
application/xml
application/json
400 application/vnd.plcm.plcm-error+xml
Bad request. Bad alias.
404 application/vnd.plcm.plcm-error+xml
Requested resource could not be found

https://localhost:8443/api/rest/pki//certificates/trusted/{alias}/download


Template Parameters

Name Type Description
alias xs:string

Methods

GET

Request

Response

Status Representation Description
200 application/pkix-cert
400 application/vnd.plcm.plcm-error+xml
Bad request. Bad alias.
404 application/vnd.plcm.plcm-error+xml
Requested resource could not be found

https://localhost:8443/api/rest/pki//certificates/identity


Methods

GET

List all identity certificates. In most cases there is just one

Request

Response

Status Representation Description
200 application/vnd.plcm.plcm-certificate-info-list+xml
application/xml
text/xml
application/vnd.plcm.plcm-certificate-info-list+json
application/json
406 text/plain
Unacceptable. Invalid accept header

POST

Install a new identity certificate by uploading certificate or chain and private key

Request

Representations

application/x-www-form-urlencoded

Response

Status Representation Description
201 text/plain

POST

Install a new identity certificate by uploading encoded certificate or chain

Request

Representations

application/vnd.plcm.plcm-certificate-material+xml
application/vnd.plcm.plcm-certificate-material+json

Response

Status Representation Description
201 text/plain
406 text/plain
Unacceptable. Invalid content-type header
400 text/plain
Bad request. Data may not conform to format

POST

Install a new identity certificate by uploading certificate or chain bytes

Request

Representations

application/octet-stream

Response

Status Representation Description
201 text/plain

https://localhost:8443/api/rest/pki//certificates/identity/{alias}


Template Parameters

Name Type Description
alias xs:string

Methods

DELETE

Request

Response

Status Representation Description
204 application/octet-stream
404 application/vnd.plcm.plcm-error+xml
Requested resource could not be found

GET

Get details of current identity certificate in text

Request

Response

Status Representation Description
200 application/vnd.plcm.plcm-certificate-info+xml
application/vnd.plcm.plcm-certificate-info+json
application/xml
application/json
404 application/vnd.plcm.plcm-error+xml
Requested resource could not be found
406 text/plain
Unacceptable. Invalid accept header

https://localhost:8443/api/rest/pki//certificates/identity/{alias}/download


Template Parameters

Name Type Description
alias xs:string

Methods

GET

Request

Response

Status Representation Description
200 application/pkix-cert
400 application/vnd.plcm.plcm-error+xml
Bad request. Bad alias.
404 application/vnd.plcm.plcm-error+xml
Requested resource could not be found
406 text/plain
Unacceptable. Invalid accept header

GET

Download of identity certificate of given alias in pkcs12 format

Request

Query Parameters

Name Type Description
passphrase xs:string

Response

Status Representation Description
200 application/x-pkcs12
400 application/vnd.plcm.plcm-error+xml
Bad request. Bad alias.
404 application/vnd.plcm.plcm-error+xml
Requested resource could not be found
406 text/plain
Unacceptable. Invalid accept header

https://localhost:8443/api/rest/pki//csrs


Methods

GET


Get a list of all certificate signing requests

Request

Response

Status Representation Description
200 application/vnd.plcm.plcm-certificate-signing-request-list+xml
application/xml
text/xml
application/vnd.plcm.plcm-certificate-signing-request-list+json
application/json
Successfully retrieved all certificate signing requests
406 text/plain
Not acceptable. Invalid accept header.

POST

Create a new certificate signing request

Request

Representations

application/vnd.plcm.plcm-certificate-signing-request-specification+xml
application/xml
text/xml
application/json
application/vnd.plcm.plcm-certificate-signing-request-specification+json

Response

Status Representation Description
201 text/plain
A new CSR was successfully created
406 text/plain
Not acceptable. Invalid content type header.

https://localhost:8443/api/rest/pki//csrs/{alias}


Template Parameters

Name Type Description
alias xs:string

Methods

DELETE

Delete a csr with given alias

Request

Response

Status Representation Description
204
404 text/plain
CSR with given csrId could not be found

https://localhost:8443/api/rest/pki//csrs/{csrId}


Template Parameters

Name Type Description
csrId xs:string

Methods

GET

Request

Response

Status Representation Description
200 application/pkcs10
application/octet-stream
406 text/plain
Not acceptable. Invalid content accept header.
404 text/plain
CSR with given csrId could not be found

GET

Get a csr given an alias. Text with details of CSR returned

Request

Response

Status Representation Description
200 application/vnd.plcm.plcm-certificate-signing-request+xml
application/xml
text/xml
application/vnd.plcm.plcm-certificate-signing-request+json
application/json
406 text/plain
Not acceptable. Invalid content accept header.
404 text/plain
CSR with given csrId could not be found

https://localhost:8443/api/rest/pki//csrs/{csrId}/download


Template Parameters

Name Type Description
csrId xs:string

Methods

GET

Request

Response

Status Representation Description
200 application/pkcs10
application/octet-stream
406 text/plain
Not acceptable. Invalid content accept header.
404 text/plain
CSR with given csrId could not be found