Documentation

Mistake on this page? Email us
Public Member Functions | Static Public Member Functions | Properties | List of all members
MbedCloudSDK.Certificates.Model.Certificate Class Reference

Certificate More...

Inheritance diagram for MbedCloudSDK.Certificates.Model.Certificate:
Mbed.Cloud.Common.Entity Mbed.Cloud.Common.IEntity

Public Member Functions

override string ToString ()
 Returns the string presentation of the object. More...
 

Static Public Member Functions

static TrustedCertificateReq.ServiceEnum GetServiceEnum (CertificateType type)
 Get Service Enum More...
 
static TrustedCertificateUpdateReq.ServiceEnum GetUpdateServiceEnum (Certificate certificate)
 Get update service enum More...
 
static TrustedCertificateUpdateReq.StatusEnum GetUpdateStatusEnum (Certificate certificate)
 Get update status enum More...
 
static Certificate MapTrustedCert (iam.Model.TrustedCertificateResp trustedCertificate, Certificate certificate=null, CertificatesApi api=null, string signature=null)
 Map to Certificate object. More...
 
static Certificate MapDeveloperCert (connector_ca.Model.DeveloperCertificateResponseData developerCertificateData, Certificate certificate=null)
 Map to Certificate object. More...
 

Properties

CertificateType Type [get]
 Gets type of Certificate More...
 
string Description [get, set]
 Gets or sets human readable description of this certificate. More...
 
int DeviceExecutionMode [get, set]
 Gets or sets device execution mode where 1 means a developer certificate. More...
 
DateTime CreatedAt [get]
 Gets creation UTC time RFC3339. More...
 
string Subject [get]
 Gets subject of the certificate. More...
 
string AccountId [get]
 Gets the UUID of the account. More...
 
string Signature [get, set]
 Gets or sets base 64 encoded SHA256 hash of AccountID. More...
 
DateTime Validity [get, set]
 Gets or sets expiration time in UTC formatted as RFC3339. More...
 
string Issuer [get]
 Gets issuer of the certificate. More...
 
string CertificateData [get]
 Gets x509.v3 trusted certificate in PEM or base64 encoded DER format. More...
 
string Name [get, set]
 Gets or sets certificate name. More...
 
string SecurityFileContent [get, set]
 Gets or sets content of the security.c file that will be flashed into the device to provide the security credentials More...
 
string DeveloperCertificate [get]
 Gets PEM format X.509 developer certificate. More...
 
string ServerUri [get]
 Gets URI to which the client needs to connect to. More...
 
string DeveloperPrivateKey [get]
 Gets PEM format developer private key associated to the certificate. More...
 
string ServerCertificate [get]
 Gets PEM format X.509 server certificate that will be used to validate the server certificate and that will be received during the TLS/DTLS handshake. More...
 
CertificateStatus Status [get]
 Gets the Status of the certificate. More...
 
string OwnerId [get]
 Gets bootstrap server URI to which the client needs to connect to. More...
 
bool EnrollmentMode [get, set]
 Gets or sets the enrollment mode. If true, signature parameter is not required. Default value is false. More...
 
DateTime UpdatedAt = false [get]
 Gets the time certificate was updated More...
 
string HeaderFile [get]
 Gets Content of the security.c file that will be flashed into the device to provide the security credentials. More...
 
- Properties inherited from Mbed.Cloud.Common.Entity
string Id [get, set]
 Gets or sets the identifier. More...
 
- Properties inherited from Mbed.Cloud.Common.IEntity
string Id [get, set]
 Gets or sets the identifier. More...
 

Detailed Description

Certificate

Member Function Documentation

static TrustedCertificateReq.ServiceEnum MbedCloudSDK.Certificates.Model.Certificate.GetServiceEnum ( CertificateType  type)
inlinestatic

Get Service Enum

Parameters
typeCertificate
Returns
Trusted Certificate Request Service Enum
static TrustedCertificateUpdateReq.ServiceEnum MbedCloudSDK.Certificates.Model.Certificate.GetUpdateServiceEnum ( Certificate  certificate)
inlinestatic

Get update service enum

Parameters
certificateCertificate
Returns
Trusted certificate update request service enum
static TrustedCertificateUpdateReq.StatusEnum MbedCloudSDK.Certificates.Model.Certificate.GetUpdateStatusEnum ( Certificate  certificate)
inlinestatic

Get update status enum

Parameters
certificateCertificate
Returns
Trusted certificate update request status enum
static Certificate MbedCloudSDK.Certificates.Model.Certificate.MapDeveloperCert ( connector_ca.Model.DeveloperCertificateResponseData  developerCertificateData,
Certificate  certificate = null 
)
inlinestatic

Map to Certificate object.

Parameters
developerCertificateDataDeveloper certificate data
certificateCertificate to be updated
Returns
Certificate
static Certificate MbedCloudSDK.Certificates.Model.Certificate.MapTrustedCert ( iam.Model.TrustedCertificateResp  trustedCertificate,
Certificate  certificate = null,
CertificatesApi  api = null,
string  signature = null 
)
inlinestatic

Map to Certificate object.

Parameters
trustedCertificateTrustedCertificate response object.
certificateCertificate to be updated.
apiCertificate Api
signatureCertificate signature
Returns
Certificate
override string MbedCloudSDK.Certificates.Model.Certificate.ToString ( )

Returns the string presentation of the object.

Returns
String presentation of the object.

Property Documentation

string MbedCloudSDK.Certificates.Model.Certificate.AccountId
get

Gets the UUID of the account.

The UUID of the account.

string MbedCloudSDK.Certificates.Model.Certificate.CertificateData
get

Gets x509.v3 trusted certificate in PEM or base64 encoded DER format.

X509.v3 trusted certificate in PEM or base64 encoded DER format.

DateTime MbedCloudSDK.Certificates.Model.Certificate.CreatedAt
get

Gets creation UTC time RFC3339.

Creation UTC time RFC3339.

string MbedCloudSDK.Certificates.Model.Certificate.Description
getset

Gets or sets human readable description of this certificate.

Human readable description of this certificate.

string MbedCloudSDK.Certificates.Model.Certificate.DeveloperCertificate
get

Gets PEM format X.509 developer certificate.

PEM format X.509 developer certificate.

string MbedCloudSDK.Certificates.Model.Certificate.DeveloperPrivateKey
get

Gets PEM format developer private key associated to the certificate.

PEM format developer private key associated to the certificate.

int MbedCloudSDK.Certificates.Model.Certificate.DeviceExecutionMode
getset

Gets or sets device execution mode where 1 means a developer certificate.

Device execution mode where 1 means a developer certificate.

bool MbedCloudSDK.Certificates.Model.Certificate.EnrollmentMode
getset

Gets or sets the enrollment mode. If true, signature parameter is not required. Default value is false.

string MbedCloudSDK.Certificates.Model.Certificate.HeaderFile
get

Gets Content of the security.c file that will be flashed into the device to provide the security credentials.

string MbedCloudSDK.Certificates.Model.Certificate.Issuer
get

Gets issuer of the certificate.

Issuer of the certificate.

string MbedCloudSDK.Certificates.Model.Certificate.Name
getset

Gets or sets certificate name.

Certificate name.

string MbedCloudSDK.Certificates.Model.Certificate.OwnerId
get

Gets bootstrap server URI to which the client needs to connect to.

Bootstrap server URI to which the client needs to connect to.

string MbedCloudSDK.Certificates.Model.Certificate.SecurityFileContent
getset

Gets or sets content of the security.c file that will be flashed into the device to provide the security credentials

Content of the security.c file that will be flashed into the device to provide the security credentials

string MbedCloudSDK.Certificates.Model.Certificate.ServerCertificate
get

Gets PEM format X.509 server certificate that will be used to validate the server certificate and that will be received during the TLS/DTLS handshake.

PEM format X.509 server certificate that will be used to validate the server certificate and that will be received during the TLS/DTLS handshake.

string MbedCloudSDK.Certificates.Model.Certificate.ServerUri
get

Gets URI to which the client needs to connect to.

URI to which the client needs to connect to.

string MbedCloudSDK.Certificates.Model.Certificate.Signature
getset

Gets or sets base 64 encoded SHA256 hash of AccountID.

Base 64 encoded SHA256 hash of AccountID.

CertificateStatus MbedCloudSDK.Certificates.Model.Certificate.Status
get

Gets the Status of the certificate.

The Status of the certificate.

string MbedCloudSDK.Certificates.Model.Certificate.Subject
get

Gets subject of the certificate.

Subject of the certificate.

CertificateType MbedCloudSDK.Certificates.Model.Certificate.Type
get

Gets type of Certificate

DateTime MbedCloudSDK.Certificates.Model.Certificate.UpdatedAt = false
get

Gets the time certificate was updated

DateTime MbedCloudSDK.Certificates.Model.Certificate.Validity
getset

Gets or sets expiration time in UTC formatted as RFC3339.

Expiration time in UTC formatted as RFC3339.


The documentation for this class was generated from the following file: