/** * Api Documentation * Api Documentation * * OpenAPI spec version: 1.0 * * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ import { XHR } from "./XHR"; import { BearerToken } from "../model/BearerToken"; import { CertificateInfo } from "../model/CertificateInfo"; import { SamlTokenResult } from "../model/SamlTokenResult"; import { TokenResponse } from "../model/TokenResponse"; import { UUIDType } from "../model/UUIDType"; export declare class fhcStsApi { host: string; headers: Array; fetchImpl?: (input: RequestInfo, init?: RequestInit) => Promise; constructor(host: string, headers: any, fetchImpl?: (input: RequestInfo, init?: RequestInit) => Promise); setHeaders(h: Array): void; handleError(e: XHR.XHRError): never; /** * Retrieves a SAML token for the user identified by the given keystoreId and passPhrase. The tokenId is used to identify the token. This endpoint is useful for obtaining a SAML token that can be used for authentication and authorization in other systems. * @summary Get a SAML token * @param xFHCKeystoreId X-FHC-keystoreId */ checkKeystoreExistUsingGET(xFHCKeystoreId: string): Promise; /** * Check that a cached SAML token is still valid. The tokenId is used to identify the token. This endpoint is useful for verifying the validity of a cached SAML token before using it for authentication or authorization. * @summary Check a SAML token validity * @param xFHCTokenId X-FHC-tokenId */ checkTokenValidUsingGET(xFHCTokenId: string): Promise; /** * Uses a previously obtained SAML token to get a Bearer token. The tokenId is used to identify the SAML token, and the passPhrase is used to decrypt the keystore file. The ssin is the social security number of the user, and the keystoreId is the UUID of the keystore file. This endpoint is useful for obtaining a Bearer token that can be used for API authentication. * @summary Get a Bearer token from a SAML token * @param xFHCTokenId X-FHC-tokenId * @param xFHCPassPhrase X-FHC-passPhrase * @param ssin ssin * @param xFHCKeystoreId X-FHC-keystoreId */ getBearerTokenUsingGET(xFHCTokenId: string, xFHCPassPhrase: string, ssin: string, xFHCKeystoreId: string): Promise; /** * Retrieves information about the keystore file associated with the given keystoreId. The keystoreId is the UUID returned by the uploadKeystore endpoint. The passPhrase is used to decrypt the keystore file. Returns a CertificateInfo object containing details about the keystore, such as validity period, owner, and other relevant information. * @summary Get information about the keystore file (validity, owner, etc.) * @param keystoreId keystoreId * @param xFHCPassPhrase X-FHC-passPhrase */ getKeystoreInfoUsingGET(keystoreId: string, xFHCPassPhrase: string): Promise; /** * Uses a previously obtained SAML token to get an OAuth2 token. The tokenId is used to identify the SAML token, and the passPhrase is used to decrypt the keystore file. The cbe (Common Business Entity) and kid (Key Identifier) are used to specify the OAuth2 token request. This endpoint is useful for obtaining an OAuth2 token that can be used for API authentication. * @summary Get a OAuth2 token from a SAML token * @param xFHCTokenId X-FHC-tokenId * @param xFHCPassPhrase X-FHC-passPhrase * @param xFHCKeystoreId X-FHC-keystoreId * @param cbe cbe * @param kid kid */ getOauth2TokenUsingGET(xFHCTokenId: string, xFHCPassPhrase: string, xFHCKeystoreId: string, cbe: string, kid: string): Promise; /** * Allows the registration of a SAML token obtained from an external source. The tokenId is used to identify the token, and the quality parameter specifies the type of token (e.g., doctor). If no quality is specified, it defaults to 'doctor'. This endpoint is useful for integrating with external systems that provide SAML tokens. * @summary Register a SAML token obtained externally * @param body token * @param xFHCTokenId X-FHC-tokenId * @param quality quality */ registerTokenUsingPOST(xFHCTokenId: string, quality?: string, body?: string): Promise; /** * Requests a token for the user identified by the given SSIN and keystoreId. The passPhrase is used to decrypt the keystore file. The quality parameter specifies the type of token to request (e.g., doctor, medicalhouse, guardpost, sortingcenter). If a previousTokenId is provided, it will be used to renew the token. * @summary Request a token * @param xFHCPassPhrase X-FHC-passPhrase * @param ssin ssin * @param xFHCKeystoreId X-FHC-keystoreId * @param quality quality * @param xFHCTokenId X-FHC-tokenId */ requestTokenUsingGET(xFHCPassPhrase: string, ssin: string, xFHCKeystoreId: string, quality: string, xFHCTokenId?: string): Promise; /** * * @summary requestToken * @param xFHCPassPhrase X-FHC-passPhrase * @param ssin ssin * @param xFHCKeystoreId X-FHC-keystoreId * @param isMedicalHouse isMedicalHouse * @param isGuardPost isGuardPost * @param isSortingCenter isSortingCenter * @param xFHCTokenId X-FHC-tokenId */ requestTokenUsingGET1(xFHCPassPhrase: string, ssin: string, xFHCKeystoreId: string, isMedicalHouse?: boolean, isGuardPost?: boolean, isSortingCenter?: boolean, xFHCTokenId?: string): Promise; /** * Uploads a keystore file to the STS service and returns the UUID of the uploaded keystore. The kestore file must be in PKCS12 format and should contain the private key and certificate chain for the user. It will never be stored anywhere but encrypted in RAM * @summary Upload a keystore file * @param file */ uploadKeystoreUsingPOST(file: ArrayBuffer | any[]): Promise; }