GET api/v1/admin/certificates

Lists all the client certificates have been assigned to the account.

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

Details of all client certificates.

TwoSms.CustomerPortalRole.API.Misc.ResponseOfSystem.Collections.Generic.ListOfTwoSms.CustomerPortalRole.API.Admin.ClientCertificates.Certificate

Name	Description	Type	Additional information
Error		TwoSms.CustomerPortalRole.API.Misc.Error	None.
ResponseData		TwoSms.CustomerPortalRole.API.Misc.ResponseDataOfSystem.Collections.Generic.ListOfTwoSms.CustomerPortalRole.API.Admin.ClientCertificates.Certificate	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": [
      {
        "CertificateAuthority": "sample string 1",
        "IssuedTo": "sample string 2",
        "KeyUsage": "sample string 3",
        "Revoked": true,
        "Thumbprint": "sample string 5",
        "ValidFrom": "2024-04-19T01:17:13.8540671+00:00",
        "ValidTo": "2024-04-19T01:17:13.8540671+00:00"
      },
      {
        "CertificateAuthority": "sample string 1",
        "IssuedTo": "sample string 2",
        "KeyUsage": "sample string 3",
        "Revoked": true,
        "Thumbprint": "sample string 5",
        "ValidFrom": "2024-04-19T01:17:13.8540671+00:00",
        "ValidTo": "2024-04-19T01:17:13.8540671+00:00"
      }
    ]
  }
}

application/xml, text/xml

Sample:

<ResponseOfListOfCertificate 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>
      <Certificate>
        <CertificateAuthority>sample string 1</CertificateAuthority>
        <IssuedTo>sample string 2</IssuedTo>
        <KeyUsage>sample string 3</KeyUsage>
        <Revoked>true</Revoked>
        <Thumbprint>sample string 5</Thumbprint>
        <ValidFrom>2024-04-19T01:17:13.8540671+00:00</ValidFrom>
        <ValidTo>2024-04-19T01:17:13.8540671+00:00</ValidTo>
      </Certificate>
      <Certificate>
        <CertificateAuthority>sample string 1</CertificateAuthority>
        <IssuedTo>sample string 2</IssuedTo>
        <KeyUsage>sample string 3</KeyUsage>
        <Revoked>true</Revoked>
        <Thumbprint>sample string 5</Thumbprint>
        <ValidFrom>2024-04-19T01:17:13.8540671+00:00</ValidFrom>
        <ValidTo>2024-04-19T01:17:13.8540671+00:00</ValidTo>
      </Certificate>
    </Detail>
  </ResponseData>
</ResponseOfListOfCertificate>