CertificateIssuersActivationApi (external

public interface CertificateIssuersActivationApi

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`retrofit2.Call<CertificateIssuerConfigResponse>`	`createCertificateIssuerConfig(CreateCertificateIssuerConfig createCertificateIssuerConfig)` Create certificate issuer configuration.
`retrofit2.Call<java.lang.Void>`	`deleteCertificateIssuerConfigByID(java.lang.String certificateIssuerConfigurationId)` Delete certificate issuer configuration.
`retrofit2.Call<CertificateIssuerConfigResponse>`	`getCertificateIssuerConfig()` Get certificate issuer configuration.
`retrofit2.Call<CertificateIssuerConfigResponse>`	`getCertificateIssuerConfigByID(java.lang.String certificateIssuerConfigurationId)` Get certificate issuer configuration.
`retrofit2.Call<CertificateIssuerConfigListResponse>`	`getCertificateIssuerConfigs(java.lang.Integer limit, java.lang.String order, java.lang.String after, java.lang.String include, java.lang.String referenceEq)` Get certificate issuer configurations.
`retrofit2.Call<CertificateIssuerConfigResponse>`	`updateCertificateIssuerConfig(CertificateIssuerConfigRequest certificateIssuerConfigRequest)` Update certificate issuer configuration.
`retrofit2.Call<CertificateIssuerConfigResponse>`	`updateCertificateIssuerConfigByID(java.lang.String certificateIssuerConfigurationId, CertificateIssuerConfigRequest certificateIssuerConfigRequest)` Update certificate issuer configuration.

Method Detail

createCertificateIssuerConfig

@Headers(value="Content-Type:application/json; charset=utf-8")
 @POST(value="v3/certificate-issuer-configurations")
retrofit2.Call<CertificateIssuerConfigResponse> createCertificateIssuerConfig(@Body
                                                                                                                                                                                                  CreateCertificateIssuerConfig createCertificateIssuerConfig)

Create certificate issuer configuration. Configure the certificate issuer to be used when creating the device custom certificates. <br> **Example usage:** ``` curl -X POST \\ -H 'authorization: <valid access token>' \\ -H 'content-type: application/json;charset=UTF-8' \\ https://api.us-east-1.mbedcloud.com/v3/certificate-issuer-configurations \\ -d '{ \"reference\": \"customer.dlms\", \"certificate_issuer_id\": \"01621a36719d507b9d48a91b00000000\" }' ```

Parameters:: createCertificateIssuerConfig - Certificate issuer configuration request (required)
Returns:: Call<CertificateIssuerConfigResponse>

deleteCertificateIssuerConfigByID

@Headers(value="Content-Type:application/json; charset=utf-8")
 @DELETE(value="v3/certificate-issuer-configurations/{certificate-issuer-configuration-id}")
retrofit2.Call<java.lang.Void> deleteCertificateIssuerConfigByID(@Path(value="certificate-issuer-configuration-id",encoded=true)
                                                                                                                                                                                                                             java.lang.String certificateIssuerConfigurationId)

Delete certificate issuer configuration. Delete the configured certificate issuer configuration. You can only delete the configurations of custom certificates.

Parameters:: certificateIssuerConfigurationId - The ID of the certificate issuer configuration. (required)
Returns:: Call<Void>

getCertificateIssuerConfig
```
@Headers(value="Content-Type:application/json; charset=utf-8")
 @GET(value="v3/certificate-issuer-configurations/lwm2m")
retrofit2.Call<CertificateIssuerConfigResponse> getCertificateIssuerConfig()
```
Get certificate issuer configuration. Provides the configured certificate issuer to be used when creating device certificates for LwM2M communication.<br>

Returns:

Call<CertificateIssuerConfigResponse>

getCertificateIssuerConfigByID

@Headers(value="Content-Type:application/json; charset=utf-8")
 @GET(value="v3/certificate-issuer-configurations/{certificate-issuer-configuration-id}")
retrofit2.Call<CertificateIssuerConfigResponse> getCertificateIssuerConfigByID(@Path(value="certificate-issuer-configuration-id",encoded=true)
                                                                                                                                                                                                                                        java.lang.String certificateIssuerConfigurationId)

Get certificate issuer configuration. Provides the configured certificate issuer.

Parameters:: certificateIssuerConfigurationId - The ID of the certificate issuer configuration. (required)
Returns:: Call<CertificateIssuerConfigResponse>

getCertificateIssuerConfigs

@Headers(value="Content-Type:application/json; charset=utf-8")
 @GET(value="v3/certificate-issuer-configurations")
retrofit2.Call<CertificateIssuerConfigListResponse> getCertificateIssuerConfigs(@Query(value="limit")
                                                                                                                                                                                                   java.lang.Integer limit,
                                                                                                                                                                                                   @Query(value="order")
                                                                                                                                                                                                   java.lang.String order,
                                                                                                                                                                                                   @Query(value="after")
                                                                                                                                                                                                   java.lang.String after,
                                                                                                                                                                                                   @Query(value="include")
                                                                                                                                                                                                   java.lang.String include,
                                                                                                                                                                                                   @Query(value="reference__eq")
                                                                                                                                                                                                   java.lang.String referenceEq)

Get certificate issuer configurations. Get certificate issuer configurations, optionally filtered by reference. <br> **Example usage:** ``` curl \\ -H 'authorization: <valid access token>' \\ -H 'content-type: application/json;charset=UTF-8' \\ https://api.us-east-1.mbedcloud.com/v3/certificate-issuer-configurations \\ ``` ``` curl \\ -H 'authorization: <valid access token>' \\ -H 'content-type: application/json;charset=UTF-8' \\ https://api.us-east-1.mbedcloud.com/v3/certificate-issuer-configurations?reference__eq=dlms \\ ``` Note: This endpoint does not implement pagination and therefore, list control parameters such as `limit` or `after` will be ignored by the system.

Parameters:: limit - How many objects to retrieve in the page. The minimum limit is 2 and the maximum is 1000. Limit values outside of this range are set to the closest limit. (optional); order - The order of the records based on creation time, `ASC` or `DESC`; by default `ASC`. (optional); after - The ID of The item after which to retrieve the next page. (optional); include - Comma-separated list of data fields to return. Currently supported: `total_count` (optional); referenceEq - The certificate name to which the certificate issuer configuration applies. (optional)
Returns:: Call<CertificateIssuerConfigListResponse>

updateCertificateIssuerConfig

@Headers(value="Content-Type:application/json; charset=utf-8")
 @PUT(value="v3/certificate-issuer-configurations/lwm2m")
retrofit2.Call<CertificateIssuerConfigResponse> updateCertificateIssuerConfig(@Body
                                                                                                                                                                                                       CertificateIssuerConfigRequest certificateIssuerConfigRequest)

Update certificate issuer configuration. Configure the certificate issuer to be used when creating device certificates for LwM2M communication. <br> **Example usage:** ``` curl -X PUT \\ -H 'authorization: <valid access token>' \\ -H 'content-type: application/json;charset=UTF-8' \\ https://api.us-east-1.mbedcloud.com/v3/certificate-issuer-configurations/lwm2m \\ -d '{ \"certificate_issuer_id\": \"01621a36719d507b9d48a91b00000000\" }' ```

Parameters:: certificateIssuerConfigRequest - Certificate Issuer Configuration Request (required)
Returns:: Call<CertificateIssuerConfigResponse>

updateCertificateIssuerConfigByID

@Headers(value="Content-Type:application/json; charset=utf-8")
 @PUT(value="v3/certificate-issuer-configurations/{certificate-issuer-configuration-id}")
retrofit2.Call<CertificateIssuerConfigResponse> updateCertificateIssuerConfigByID(@Path(value="certificate-issuer-configuration-id",encoded=true)
                                                                                                                                                                                                                                           java.lang.String certificateIssuerConfigurationId,
                                                                                                                                                                                                                                           @Body
                                                                                                                                                                                                                                           CertificateIssuerConfigRequest certificateIssuerConfigRequest)

Update certificate issuer configuration. Update the configured certificate issuer configuration.

Parameters:: certificateIssuerConfigurationId - The ID of the certificate issuer configuration. (required); certificateIssuerConfigRequest - Certificate issuer configuration request (required)
Returns:: Call<CertificateIssuerConfigResponse>

Interface CertificateIssuersActivationApi