POST api/v1/admin/certificates

Adds a new client certificate to the system. The method automatically sends an email to 2sms IT support so they can place the certificate onto the servers. The method will check for: 1) The certificate has not already been added to the system. 2) The certificate has not expired. 3) The certificate has not been revoked.

Request Information

URI Parameters

None.

Body Parameters

The certificate to be added.

TwoSms.CustomerPortalRole.API.Admin.ClientCertificates.CertificateAdd
NameDescriptionTypeAdditional information
Name

The name of the certificate file.

string

None.

RawData

Base64 encoded string containing the certificate.

string

None.

Request Formats

application/json, text/json

Sample:
{
  "Name": "sample string 1",
  "RawData": "sample string 2"
}

application/xml, text/xml

Sample:
<CertificateAdd xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Name>sample string 1</Name>
  <RawData>sample string 2</RawData>
</CertificateAdd>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

TwoSms.CustomerPortalRole.API.Misc.ResponseOfSystem.Object
NameDescriptionTypeAdditional information
Error

TwoSms.CustomerPortalRole.API.Misc.Error

None.

ResponseData

TwoSms.CustomerPortalRole.API.Misc.ResponseDataOfSystem.Object

None.

Response Formats

application/json, text/json

Sample:
{
  "Error": {
    "ErrorCode": "sample string 1",
    "ErrorReason": "sample string 2"
  },
  "ResponseData": {
    "Identification": {
      "UserId": "sample string 1"
    },
    "Result": "sample string 1",
    "Detail": {}
  }
}

application/xml, text/xml

Sample:
<ResponseOfObject xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Error>
    <ErrorCode>sample string 1</ErrorCode>
    <ErrorReason>sample string 2</ErrorReason>
  </Error>
  <ResponseData>
    <Result>sample string 1</Result>
    <Identification>
      <UserId>sample string 1</UserId>
    </Identification>
    <Detail />
  </ResponseData>
</ResponseOfObject>