Skip to main content
API docs by Redocly

Client Auth API V2 (2.0.0)

Download OpenAPI specification:Download

Client Auth authenticates the Tools Gateway & CAC login method

echo

Returns Adapt headers

GET /echo

This endpoint returns an object containing SME Connect specific headers (x-adapt- headers). It also changes the host header to be compatible with SME Connect related ones.

Responses

Response samples

Content type
application/json
{}

jwt

Returns a JWT

GET /jwt

This endpoint is called when a user is logging into SME Connect with a CAC, or when the Tools Gateway or a tool (camera, DMM, borescope) login. The header information included in this request originate from the client certificate found on the CAC or the Tools Gateway.

Many of the headers included in the "parameters" section originate from this client certificate. Many of the values will not be filled from the client certificate but are included as an exhaustive list of potential property headers.

JWT will return a JWT, User information, and Token Information.

For Tools logging into JWT, optional query parameters of a class and serial are included with the request.

query Parameters
class
string
Enum: "GenericCamera-v1" "DMM-v1" "Boroscope-v1" "OpticalMicrometer-v1"

The Tool class type

serial
string
Example: serial=75884A90_2

A tool's serial numebr

header Parameters
X-ARR-ClientCert
string

A request header injected with the client certificate

x-adapt-host
string
Example: smeconnect.dev

The Host URL

x-adapt-handler
string
Example: adapt-x509-client-auth-v2.additional.azure.information

The Code Handler

x-adapt-url
string

The header URL

x-adapt-client-issuer-name
string
Example: CN=CertificateAuthority, OU=IT, O=Organization, L=Location, S=State, C=Country

The Client Certificate Issuer Name

x-adapt-client-subject-name
string
Example: CN=NAME, OU=System, O=Organization, S=State, C=Country

The Client Certificate Subject Name

x-adapt-client-subject
string
Example: CN=NAME, OU=System, O=Organization, S=State, C=Country

The Client Certificate Subject

x-adapt-client-san-email-name
string
Example: CM4-2H@ar.turnaroundfactor.com

The Subject Alternative Name (SAN) of the user email (may be empty string)

x-adapt-client-san-dns-name
string
Example: CM4-2H

The Client Domain Name System (DNS) Name

x-adapt-client-san-simple-name
string
Example: CM4-2H

The Subject Alternative Name (SAN) of the client

x-adapt-client-san-upn-name
string
Example:

The Subject Alternative Name (SAN) - User Principle Name (UPN)

x-adapt-client-san-url-name
string
Example: urn:uuid:2fa2a266-7d97-4147-8f17-1e57105c70ea

The Subject Alternative Name (SAN) - URL

x-adapt-client-san-dns-from-alt-name
string
Example:

The alternative DNS name

x-adapt-client-other-email-name
string
Example:

A different client email

x-adapt-client-other-dns-name
string
Example:

Other Client Domain Name System (DNS)

x-adapt-client-other-simple-name
string
Example:

Other Simple Name

x-adapt-client-other-upn-name
string
Example:

Other User Principle Name (UPN)

x-adapt-client-other-url-name
string
Example:

Other URL

x-adapt-client-other-upn-name
string
Example:

Other DNS alternative name

Responses

Response samples

Content type
application/json
{
  • "session": {
    }
}