/** * Agilicus API * Agilicus is API-first. Modern software is controlled by other software, is open, is available for you to use the way you want, securely, simply. The OpenAPI Specification in YAML format is available on [www](https://www.agilicus.com/www/api/agilicus-openapi.yaml) for importing to other tools. A rendered, online viewable and usable version of this specification is available at [api](https://www.agilicus.com/api). You may try the API inline directly in the web page. To do so, first obtain an Authentication Token (the simplest way is to install the Python SDK, and then run `agilicus-cli --issuer https://MYISSUER get-token`). You will need an org-id for most calls (and can obtain from `agilicus-cli --issuer https://MYISSUER list-orgs`). The `MYISSUER` will typically be `auth.MYDOMAIN`, and you will see it as you sign-in to the administrative UI. This API releases on Bearer-Token authentication. To obtain a valid bearer token you will need to Authenticate to an Issuer with OpenID Connect (a superset of OAUTH2). Your \"issuer\" will look like https://auth.MYDOMAIN. For example, when you signed-up, if you said \"use my own domain name\" and assigned a CNAME of cloud.example.com, then your issuer would be https://auth.cloud.example.com. If you selected \"use an Agilicus supplied domain name\", your issuer would look like https://auth.myorg.agilicus.cloud. For test purposes you can use our [Python SDK](https://pypi.org/project/agilicus/) and run `agilicus-cli --issuer https://auth.MYDOMAIN get-token`. This API may be used in any language runtime that supports OpenAPI 3.0, or, you may use our [Python SDK](https://pypi.org/project/agilicus/), our [Typescript SDK](https://www.npmjs.com/package/@agilicus/angular), or our [Golang SDK](https://git.agilicus.com/pub/sdk-go). 100% of the activities in our system our API-driven, from our web-admin, through our progressive web applications, to all internals: there is nothing that is not accessible. For more information, see [developer resources](https://www.agilicus.com/developer). * * The version of the OpenAPI document: 2025.12.16 * Contact: dev@agilicus.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ import { HttpHeaders } from '@angular/common/http'; import { Observable } from 'rxjs'; import { Challenge } from '../model/models'; import { ChallengeAnswer } from '../model/models'; import { ListTOTPEnrollmentResponse } from '../model/models'; import { ListWebAuthNEnrollmentResponse } from '../model/models'; import { OneTimeUseActionChallenge } from '../model/models'; import { OneTimeUseActionChallengeResponse } from '../model/models'; import { TOTPEnrollment } from '../model/models'; import { TOTPEnrollmentAnswer } from '../model/models'; import { WebAuthNEnrollment } from '../model/models'; import { WebAuthNEnrollmentAnswer } from '../model/models'; import { Configuration } from '../configuration'; export interface CreateChallengeRequestParams { Challenge: Challenge; } export interface CreateOneTimeUseActionRequestParams { OneTimeUseActionChallenge: OneTimeUseActionChallenge; } export interface CreateTotpEnrollmentRequestParams { TOTPEnrollment: TOTPEnrollment; } export interface CreateWebauthnEnrollmentRequestParams { WebAuthNEnrollment: WebAuthNEnrollment; } export interface DeleteChallengeRequestParams { challenge_id: string; } export interface DeleteTotpEnrollmentRequestParams { totp_id: string; user_id?: string; } export interface DeleteWebauthnEnrollmentRequestParams { webauthn_id: string; user_id?: string; } export interface GetAnswerRequestParams { challenge_id: string; challenge_answer: string; allowed: boolean; challenge_type: string; challenge_uid?: string; } export interface GetChallengeRequestParams { challenge_id: string; } export interface GetTotpEnrollmentRequestParams { totp_id: string; user_id?: string; } export interface GetWebauthnEnrollmentRequestParams { webauthn_id: string; user_id?: string; } export interface ListTotpEnrollmentRequestParams { limit?: number; user_id?: string; } export interface ListWebauthnEnrollmentsRequestParams { limit?: number; user_id?: string; } export interface ReplaceChallengeRequestParams { challenge_id: string; Challenge: Challenge; } export interface UpdateTotpEnrollmentRequestParams { totp_id: string; TOTPEnrollmentAnswer: TOTPEnrollmentAnswer; user_id?: string; } export interface UpdateWebauthnEnrollmentRequestParams { webauthn_id: string; WebAuthNEnrollmentAnswer: WebAuthNEnrollmentAnswer; user_id?: string; } export interface ChallengesServiceInterface { defaultHeaders: HttpHeaders; configuration: Configuration; /** * create a challenge * Creates a challenge according to the provide specification. This challenge will persist for a period of time waiting for the challenge to be passed. It will eventually time out. * @param requestParameters */ createChallenge(requestParameters: CreateChallengeRequestParams, observe?: any, extraHeaders?: HttpHeaders): Observable; /** * create a one time use action challenge * Creates a one time use challenge according to the provide specification. This challenge will persist for a period of time waiting for the challenge to be passed. It will eventually time out. If the challenge is accepted or declined, the system will perform an action according to the configuration provided on challenge creation and the provided answer. * @param requestParameters */ createOneTimeUseAction(requestParameters: CreateOneTimeUseActionRequestParams, observe?: any, extraHeaders?: HttpHeaders): Observable; /** * create a TOTP challenge enrollment * Creates a TOTP challenge enrollment. The returned body will contain the key the user needs to enroll in their application. The enrollment is not complete until the user provides a valid answer. * @param requestParameters */ createTotpEnrollment(requestParameters: CreateTotpEnrollmentRequestParams, observe?: any, extraHeaders?: HttpHeaders): Observable; /** * create a WebAuthN challenge enrollment * Initiates a WebAuthN challenge enrollment. The enrollment is not complete until the user provides a valid answer. * @param requestParameters */ createWebauthnEnrollment(requestParameters: CreateWebauthnEnrollmentRequestParams, observe?: any, extraHeaders?: HttpHeaders): Observable; /** * Delete the challenge specified by challenge_id * Delete the challenge specified by challenge_id * @param requestParameters */ deleteChallenge(requestParameters: DeleteChallengeRequestParams, observe?: any, extraHeaders?: HttpHeaders): Observable<{}>; /** * Delete the TOTP enrollment specified by totp id * Delete the TOTP enrollment specified by totp id * @param requestParameters */ deleteTotpEnrollment(requestParameters: DeleteTotpEnrollmentRequestParams, observe?: any, extraHeaders?: HttpHeaders): Observable<{}>; /** * Delete the WebAuthN enrollment specified by webauthn_id * Delete the WebAuthN enrollment specified by webauthn_id * @param requestParameters */ deleteWebauthnEnrollment(requestParameters: DeleteWebauthnEnrollmentRequestParams, observe?: any, extraHeaders?: HttpHeaders): Observable<{}>; /** * answer a challenge * Checks whether the challenge answer is correct. If the challenge is not accepting answers, or the anwer is incorrect, a failure will be returned. Otherwise, the challenge will be considered answered and the user can log in. * @param requestParameters */ getAnswer(requestParameters: GetAnswerRequestParams, observe?: any, extraHeaders?: HttpHeaders): Observable; /** * Get the challenge specified by challenge_id * Get the challenge specified by challenge_id * @param requestParameters */ getChallenge(requestParameters: GetChallengeRequestParams, observe?: any, extraHeaders?: HttpHeaders): Observable; /** * Get the TOTP enrollment specified by totp_id * Get the TOTP enrollment specified by totp_id * @param requestParameters */ getTotpEnrollment(requestParameters: GetTotpEnrollmentRequestParams, observe?: any, extraHeaders?: HttpHeaders): Observable; /** * Get the WebAuthN enrollment specified by webauthn_id * Get the WebAuthN enrollment specified by webauthn_id * @param requestParameters */ getWebauthnEnrollment(requestParameters: GetWebauthnEnrollmentRequestParams, observe?: any, extraHeaders?: HttpHeaders): Observable; /** * List the totp enrollment results * List the totp enrollment results * @param requestParameters */ listTotpEnrollment(requestParameters: ListTotpEnrollmentRequestParams, observe?: any, extraHeaders?: HttpHeaders): Observable; /** * List the webauthn enrollments * List the webauthn enrollments * @param requestParameters */ listWebauthnEnrollments(requestParameters: ListWebauthnEnrollmentsRequestParams, observe?: any, extraHeaders?: HttpHeaders): Observable; /** * Replace the challenge specified by challenge_id * Replace the challenge specified by challenge_id * @param requestParameters */ replaceChallenge(requestParameters: ReplaceChallengeRequestParams, observe?: any, extraHeaders?: HttpHeaders): Observable; /** * Update the totp_enrollment if the answer provided is correct. * Update the totp_enrollment if the answer provided is correct. This moves the state from pending to success. * @param requestParameters */ updateTotpEnrollment(requestParameters: UpdateTotpEnrollmentRequestParams, observe?: any, extraHeaders?: HttpHeaders): Observable; /** * Update the WebAuthN enrollment if the answer provided is correct. * Update the WebAuthN enrollment if the answer provided is correct. This completes the device enrollment. * @param requestParameters */ updateWebauthnEnrollment(requestParameters: UpdateWebauthnEnrollmentRequestParams, observe?: any, extraHeaders?: HttpHeaders): Observable; }