Returns the list of all the AllowedCertificate.
If the flag AllowedCertificatesResult.limitExceeded is set, the maximum number of entries to be returned has been reached, more pkis exist and can be read by moving the offset forward in a new request
Example to get all AllowedCertificates:
String apiPath = "allowedCertificates.xml"; WebResource apisWeb = client.resource(API_URL).path(apiPath); AllowedCertificatesResult result; int offset = 0; do { // if the "limit" queryParam is not initialized, limit default value = 50 // if the "offset" queryParam is not initialized, offset default value = 0 apisWeb = apisWeb.queryParam("limit", "" + limit); if (offset > 0) apisWeb = apisWeb.queryParam("offset", "" + offset); result = apisWeb.get(AllowedCertificatesResult.class); offset += limit; } while (result.isLimitExceeded()):
Example of query in CURL :
curl --user 'username:password' -k https://api-sandbox.everyware-cloud.com/v2/allowedCertificates
name | type | description | default | constraints |
---|---|---|---|---|
limit | query | Maximum number of entries to be returned. Note that an error will be returned if the maximum allowed value is exceeded. | 50 | required |
offset | query | Starting offset for the entries to be returned. Note that an error will be returned if the maximum allowed value is exceeded. | 0 | required |
media type | data type | description |
---|---|---|
application/json | AllowedCertificatesResult (JSON) | The list of requested AllowedCertificates. |
application/xml | allowedCertificatesResult (XML) |
GET /allowedCertificates
Content-Type: */*
Accept: application/json
...
HTTP/1.1 200 OK
Content-Type: application/json
{
"limitExceeded" : true,
"allowedCertificate" : [ {
"pkiStatus" : "REVOKED",
"pkiAllowedCertificateStatus" : "INSTALL_FAILED",
"digest" : "...",
"id" : 12345,
"certificate" : "...",
"accountId" : 12345,
"version" : 12345,
"serial" : "...",
"algorithm" : "...",
"subject" : "...",
"issuer" : "...",
"notBefore" : 12345,
"notAfter" : 12345,
"createdOn" : 12345,
"createdBy" : 12345,
"modifiedOn" : 12345,
"modifiedBy" : 12345,
"name" : "...",
"optlock" : 12345
}, {
"pkiStatus" : "EXPIRED",
"pkiAllowedCertificateStatus" : "UNINSTALL_FAILED",
"digest" : "...",
"id" : 12345,
"certificate" : "...",
"accountId" : 12345,
"version" : 12345,
"serial" : "...",
"algorithm" : "...",
"subject" : "...",
"issuer" : "...",
"notBefore" : 12345,
"notAfter" : 12345,
"createdOn" : 12345,
"createdBy" : 12345,
"modifiedOn" : 12345,
"modifiedBy" : 12345,
"name" : "...",
"optlock" : 12345
} ]
}
Creates a new AllowedCertificate based on the information provided in AllowedCertificateCreator parameter.
media type | data type | description |
---|---|---|
application/json | AllowedCertificateCreator (JSON) | Provides the information for the new AllowedCertificate to be created. |
application/xml | allowedCertificateCreator (XML) |
media type | data type | description |
---|---|---|
application/json | AllowedCertificate (JSON) | The newly created AllowedCertificate. |
application/xml | allowedCertificate (XML) |
POST /allowedCertificates
Content-Type: application/json
Accept: application/json
{
"pkiStatus" : "...",
"pkiAllowedCertificateStatus" : "...",
"certificate" : "...",
"privateKey" : "...",
"password" : "...",
"accountId" : 12345,
"version" : 12345,
"serial" : "...",
"algorithm" : "...",
"subject" : "...",
"issuer" : "...",
"notBefore" : 12345,
"notAfter" : 12345,
"createdOn" : 12345,
"createdBy" : 12345,
"name" : "..."
}
HTTP/1.1 201 Created
Content-Type: application/json
{
"pkiStatus" : "VALID",
"pkiAllowedCertificateStatus" : "PENDING_INSTALL",
"digest" : "...",
"id" : 12345,
"certificate" : "...",
"accountId" : 12345,
"version" : 12345,
"serial" : "...",
"algorithm" : "...",
"subject" : "...",
"issuer" : "...",
"notBefore" : 12345,
"notAfter" : 12345,
"createdOn" : 12345,
"createdBy" : 12345,
"modifiedOn" : 12345,
"modifiedBy" : 12345,
"name" : "...",
"optlock" : 12345
}
Updates the AllowedCertificate provided in the request body.
media type | data type | description |
---|---|---|
application/json | AllowedCertificate (JSON) | The modified AllowedCertificate whose attributes need to be updated. |
application/xml | allowedCertificate (XML) |
media type | data type | description |
---|---|---|
application/json | AllowedCertificate (JSON) | The updated AllowedCertificate. |
application/xml | allowedCertificate (XML) |
PUT /allowedCertificates
Content-Type: application/json
Accept: application/json
{
"pkiStatus" : "SUSPENDED",
"pkiAllowedCertificateStatus" : "PENDING_UNINSTALL",
"digest" : "...",
"id" : 12345,
"certificate" : "...",
"accountId" : 12345,
"version" : 12345,
"serial" : "...",
"algorithm" : "...",
"subject" : "...",
"issuer" : "...",
"notBefore" : 12345,
"notAfter" : 12345,
"createdOn" : 12345,
"createdBy" : 12345,
"modifiedOn" : 12345,
"modifiedBy" : 12345,
"name" : "...",
"optlock" : 12345
}
HTTP/1.1 204 No Content
Content-Type: application/json
{
"pkiStatus" : "VALID",
"pkiAllowedCertificateStatus" : "INSTALL_FAILED",
"digest" : "...",
"id" : 12345,
"certificate" : "...",
"accountId" : 12345,
"version" : 12345,
"serial" : "...",
"algorithm" : "...",
"subject" : "...",
"issuer" : "...",
"notBefore" : 12345,
"notAfter" : 12345,
"createdOn" : 12345,
"createdBy" : 12345,
"modifiedOn" : 12345,
"modifiedBy" : 12345,
"name" : "...",
"optlock" : 12345
}
Returns the list of all the revoked AllowedCertificate.
name | type | description | default | constraints |
---|---|---|---|---|
limit | query | Maximum number of entries to be returned. Note that an error will be returned if the maximum allowed value is exceeded. | 50 | required |
offset | query | Starting offset for the entries to be returned. Note that an error will be returned if the maximum allowed value is exceeded. | 0 | required |
media type | data type | description |
---|---|---|
application/json | AllowedCertificatesResult (JSON) | The list of requested revoked AllowedCertificates. |
application/xml | allowedCertificatesResult (XML) |
GET /allowedCertificates/revokedList
Content-Type: */*
Accept: application/json
...
HTTP/1.1 200 OK
Content-Type: application/json
{
"limitExceeded" : true,
"allowedCertificate" : [ {
"pkiStatus" : "VALID",
"pkiAllowedCertificateStatus" : "INSTALL_FAILED",
"digest" : "...",
"id" : 12345,
"certificate" : "...",
"accountId" : 12345,
"version" : 12345,
"serial" : "...",
"algorithm" : "...",
"subject" : "...",
"issuer" : "...",
"notBefore" : 12345,
"notAfter" : 12345,
"createdOn" : 12345,
"createdBy" : 12345,
"modifiedOn" : 12345,
"modifiedBy" : 12345,
"name" : "...",
"optlock" : 12345
}, {
"pkiStatus" : "SUSPENDED",
"pkiAllowedCertificateStatus" : "INSTALL_FAILED",
"digest" : "...",
"id" : 12345,
"certificate" : "...",
"accountId" : 12345,
"version" : 12345,
"serial" : "...",
"algorithm" : "...",
"subject" : "...",
"issuer" : "...",
"notBefore" : 12345,
"notAfter" : 12345,
"createdOn" : 12345,
"createdBy" : 12345,
"modifiedOn" : 12345,
"modifiedBy" : 12345,
"name" : "...",
"optlock" : 12345
} ]
}
Deletes the AllowedCertificate specified by the "allowedCertificateId" path parameter.
name | type | description |
---|---|---|
allowedCertificateId | path | The id of the AllowedCertificate to be deleted. |
DELETE /allowedCertificates/{allowedCertificateId}
Content-Type: */*
...
HTTP/1.1 204 No Content
Returns the AllowedCertificate identified by the specified allowedCertificateId.
Example of query in CURL :
curl --user 'username:password' -k https://api-sandbox.everyware-cloud.com/v2/allowedCertificates/{allowedCertificateId}.xml | xmllint --format -
name | type | description |
---|---|---|
allowedCertificateId | path | The AllowedCertificate ID of the AllowedCertificate requested. |
media type | data type | description |
---|---|---|
application/json | AllowedCertificate (JSON) | The AllowedCertificate requested. |
application/xml | allowedCertificate (XML) |
GET /allowedCertificates/{allowedCertificateId}
Content-Type: */*
Accept: application/json
...
HTTP/1.1 200 OK
Content-Type: application/json
{
"pkiStatus" : "EXPIRED",
"pkiAllowedCertificateStatus" : "UNINSTALL_FAILED",
"digest" : "...",
"id" : 12345,
"certificate" : "...",
"accountId" : 12345,
"version" : 12345,
"serial" : "...",
"algorithm" : "...",
"subject" : "...",
"issuer" : "...",
"notBefore" : 12345,
"notAfter" : 12345,
"createdOn" : 12345,
"createdBy" : 12345,
"modifiedOn" : 12345,
"modifiedBy" : 12345,
"name" : "...",
"optlock" : 12345
}
try to install the AllowedCertificate specified by the "allowedCertificateId" path parameter into the message broker truststore.
name | type | description |
---|---|---|
allowedCertificateId | path | The id of the AllowedCertificate to be installed. |
POST /allowedCertificates/install/{allowedCertificateId}
Content-Type: */*
...
HTTP/1.1 201 Created
revoke the AllowedCertificate specified by the "allowedCertificateId" path parameter.
name | type | description |
---|---|---|
allowedCertificateId | path | The id of the AllowedCertificate to be revoked. |
media type | data type | description |
---|---|---|
application/json | AllowedCertificatesResult (JSON) | |
application/xml | allowedCertificatesResult (XML) |
POST /allowedCertificates/revoke/{allowedCertificateId}
Content-Type: */*
Accept: application/json
...
HTTP/1.1 201 Created
Content-Type: application/json
{
"limitExceeded" : true,
"allowedCertificate" : [ {
"pkiStatus" : "REVOKED",
"pkiAllowedCertificateStatus" : "INSTALL_FAILED",
"digest" : "...",
"id" : 12345,
"certificate" : "...",
"accountId" : 12345,
"version" : 12345,
"serial" : "...",
"algorithm" : "...",
"subject" : "...",
"issuer" : "...",
"notBefore" : 12345,
"notAfter" : 12345,
"createdOn" : 12345,
"createdBy" : 12345,
"modifiedOn" : 12345,
"modifiedBy" : 12345,
"name" : "...",
"optlock" : 12345
}, {
"pkiStatus" : "VALID",
"pkiAllowedCertificateStatus" : "INSTALL_FAILED",
"digest" : "...",
"id" : 12345,
"certificate" : "...",
"accountId" : 12345,
"version" : 12345,
"serial" : "...",
"algorithm" : "...",
"subject" : "...",
"issuer" : "...",
"notBefore" : 12345,
"notAfter" : 12345,
"createdOn" : 12345,
"createdBy" : 12345,
"modifiedOn" : 12345,
"modifiedBy" : 12345,
"name" : "...",
"optlock" : 12345
} ]
}