MobileAppAuthenticationApi

All URIs are relative to http://127.0.0.1:8000/api

Method HTTP request Description
tokenAcquire POST /mobile/acquire-token Acquire a token for the user
tokenRequestEmailCode POST /mobile/request-email-code Request an email 2FA code for mobile authentication
tokenTwoFactorStatus POST /mobile/two-factor-status Get user\'s 2FA status and available methods
tokenVerifyTwoFactor POST /mobile/verify-two-factor Verify two-factor authentication and acquire token
tokenWipe GET /mobile/wipe Revoke all the token for the current user

tokenAcquire

TokenAcquire201Response tokenAcquire(acquireTokenMobileAppAuthenticationRequest)

Example

import {
    MobileAppAuthenticationApi,
    Configuration,
    AcquireTokenMobileAppAuthenticationRequest
} from './api';

const configuration = new Configuration();
const apiInstance = new MobileAppAuthenticationApi(configuration);

let acquireTokenMobileAppAuthenticationRequest: AcquireTokenMobileAppAuthenticationRequest; //

const { status, data } = await apiInstance.tokenAcquire(
    acquireTokenMobileAppAuthenticationRequest
);

Parameters

Name Type Description Notes
acquireTokenMobileAppAuthenticationRequest AcquireTokenMobileAppAuthenticationRequest    

Return type

TokenAcquire201Response

Authorization

No authorization required

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| |201 | | - | |202 | No 2FA code provided, require 2FA | - | |422 | Validation error | - |

Back to top Back to API list Back to Model list Back to README

tokenRequestEmailCode

TokenRequestEmailCode200Response tokenRequestEmailCode(requestEmailCodeMobileAppAuthenticationRequest)

Example

import {
    MobileAppAuthenticationApi,
    Configuration,
    RequestEmailCodeMobileAppAuthenticationRequest
} from './api';

const configuration = new Configuration();
const apiInstance = new MobileAppAuthenticationApi(configuration);

let requestEmailCodeMobileAppAuthenticationRequest: RequestEmailCodeMobileAppAuthenticationRequest; //

const { status, data } = await apiInstance.tokenRequestEmailCode(
    requestEmailCodeMobileAppAuthenticationRequest
);

Parameters

Name Type Description Notes
requestEmailCodeMobileAppAuthenticationRequest RequestEmailCodeMobileAppAuthenticationRequest    

Return type

TokenRequestEmailCode200Response

Authorization

No authorization required

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| |200 | `EmailCodeRequestResource` | - | |422 | Validation error | - |

Back to top Back to API list Back to Model list Back to README

tokenTwoFactorStatus

TokenTwoFactorStatus200Response tokenTwoFactorStatus(twoFactorStatusMobileAppAuthenticationRequest)

Example

import {
    MobileAppAuthenticationApi,
    Configuration,
    TwoFactorStatusMobileAppAuthenticationRequest
} from './api';

const configuration = new Configuration();
const apiInstance = new MobileAppAuthenticationApi(configuration);

let twoFactorStatusMobileAppAuthenticationRequest: TwoFactorStatusMobileAppAuthenticationRequest; //

const { status, data } = await apiInstance.tokenTwoFactorStatus(
    twoFactorStatusMobileAppAuthenticationRequest
);

Parameters

Name Type Description Notes
twoFactorStatusMobileAppAuthenticationRequest TwoFactorStatusMobileAppAuthenticationRequest    

Return type

TokenTwoFactorStatus200Response

Authorization

No authorization required

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| |200 | `TwoFactorStatusResource` | - | |422 | Validation error | - |

Back to top Back to API list Back to Model list Back to README

tokenVerifyTwoFactor

TokenAcquire201Response tokenVerifyTwoFactor(verifyTwoFactorMobileAppAuthenticationRequest)

Example

import {
    MobileAppAuthenticationApi,
    Configuration,
    VerifyTwoFactorMobileAppAuthenticationRequest
} from './api';

const configuration = new Configuration();
const apiInstance = new MobileAppAuthenticationApi(configuration);

let verifyTwoFactorMobileAppAuthenticationRequest: VerifyTwoFactorMobileAppAuthenticationRequest; //

const { status, data } = await apiInstance.tokenVerifyTwoFactor(
    verifyTwoFactorMobileAppAuthenticationRequest
);

Parameters

Name Type Description Notes
verifyTwoFactorMobileAppAuthenticationRequest VerifyTwoFactorMobileAppAuthenticationRequest    

Return type

TokenAcquire201Response

Authorization

No authorization required

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| |201 | | - | |422 | Validation error | - |

Back to top Back to API list Back to Model list Back to README

tokenWipe

tokenWipe()

Example

import {
    MobileAppAuthenticationApi,
    Configuration
} from './api';

const configuration = new Configuration();
const apiInstance = new MobileAppAuthenticationApi(configuration);

const { status, data } = await apiInstance.tokenWipe();

Parameters

This endpoint does not have any parameters.

Return type

void (empty response body)

Authorization

http

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| |204 | No content | - | |401 | Unauthenticated | - |

Back to top Back to API list Back to Model list Back to README

This documentation was automatically generated from the TypeScript API client.