GET api/v1/admin/users/{id}/certificates

Lists all the client certificates that have assigned to the user.

Request Information

URI Parameters

Name	Description	Type	Additional information
id	The ID of the user to fetch the certificates.	globally unique identifier	Required

Body Parameters

None.

Response Information

Resource Description

The user 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-24T01:38:21.7376349+00:00",
        "ValidTo": "2024-04-24T01:38:21.7376349+00:00"
      },
      {
        "CertificateAuthority": "sample string 1",
        "IssuedTo": "sample string 2",
        "KeyUsage": "sample string 3",
        "Revoked": true,
        "Thumbprint": "sample string 5",
        "ValidFrom": "2024-04-24T01:38:21.7376349+00:00",
        "ValidTo": "2024-04-24T01:38:21.7376349+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-24T01:38:21.7376349+00:00</ValidFrom>
        <ValidTo>2024-04-24T01:38:21.7376349+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-24T01:38:21.7376349+00:00</ValidFrom>
        <ValidTo>2024-04-24T01:38:21.7376349+00:00</ValidTo>
      </Certificate>
    </Detail>
  </ResponseData>
</ResponseOfListOfCertificate>