Skip to main content
API docs by Redocly

Card Information API (1.0.0)

Download OpenAPI specification:Download

License: PROPRIETARY

This API is implemented by the identity provider to receive information from the public certificate read from a users CAC/PIV card. SmartBridge sends the identity provider data from the users public certificate after verifying the certificate is trusted. SmartBridge provides an error if the certificate is not trusted.

Information from the user's public certificate.

Information about the CAC/PIF user from the public certificate on their smart card. All data elements in this API are available in the IL2 environment.

Request Body schema: application/json

The full information from the CAC Card including a JWTPayload for verification the information is from Netrist SmartBridge

jwt
required
string <jwt>

the encoded string representation of the JWT - Payload is described here '#/components/schema/JWTPayload'

emailAddress
string

email address

edipi
string

DoD ID - only available in specific environment

purposes
Array of strings

A list of purposes for which this certificate is used

subjectDistinguishedName
required
string

A string representing the subject's distinguished name for the user (in standard format)

subjectCountry
string

A code representing the country

subjectState
string

A code representing the state

subjectLocality
string

The locality, typically city

subjectOrganization
string

The organization the subject is a part of

subjectOrganizationUnit
string

The unit of the organization the subject is a part of

subjectCommonName
string

The common name of the subject, including EDIPI - typically FIRST.MIDDLE.LAST.EDIPI. In some environments, EDIPI may be stripped.

issuerDistinguishedName
required
string

A string representing the issuer's distinguished name (in standard format)

notAfter
required
string <date-time>

The date and time (in UTC) after which this certificate is no longer valid

notBefore
required
string <date-time>

The date and time (in UTC) before which this certificate is not valid

sha1Fingerprint
string
sha256Fingerprint
string
serialNum
string

serial number from the CAC's certificate

Responses

Request samples

Content type
application/json
{
  • "jwt": "eyJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJuZXRyaXN0c21hcnRicmlkZ2UuY29tIiwiYXVkIjoiYXBpLm5ldHJpc3RzbWFydGJyaWRnZS5jb20iLCJzdWIiOiJTdGV2ZUBleGFtcGxlLmNvbSIsImV4cCI6MTYyMDM4ODg1MiwiaWF0IjoxNjIwMzg4NTUyLCJqdGkiOiI3OGQ0NTY0OC04M2Y2LTQ2YmEtOTgyNi1kMmE0MjdjYTU3NjIifQ.GgTtZL7yBG3kiuC-A1LOXHd1AX-u5cSRnNJYv8RS9X0",
  • "emailAddress": "string",
  • "edipi": "string",
  • "purposes": [
    ],
  • "subjectDistinguishedName": "string",
  • "subjectCountry": "string",
  • "subjectState": "string",
  • "subjectLocality": "string",
  • "subjectOrganization": "string",
  • "subjectOrganizationUnit": "string",
  • "subjectCommonName": "string",
  • "issuerDistinguishedName": "string",
  • "notAfter": "2022-06-13T14:00:03Z",
  • "notBefore": "2020-06-13T14:00:04Z",
  • "sha1Fingerprint": "string",
  • "sha256Fingerprint": "string",
  • "serialNum": "string"
}