Skip to content

Latest commit

 

History

History
836 lines (561 loc) · 25.7 KB

AuthApi.md

File metadata and controls

836 lines (561 loc) · 25.7 KB
Raw

djangoflow_openapi.api.AuthApi

Load the API package

import 'package:djangoflow_openapi/api.dart';

All URIs are relative to http://localhost

Method HTTP request Description
authOtpCreate POST /api/v1/auth/otp/
authOtpDevicesConfirmCreate POST /api/v1/auth/otp-devices/{id}/confirm/
authOtpDevicesCreate POST /api/v1/auth/otp-devices/
authOtpDevicesDestroy DELETE /api/v1/auth/otp-devices/{id}/
authOtpDevicesList GET /api/v1/auth/otp-devices/
authOtpDevicesRetrieve GET /api/v1/auth/otp-devices/{id}/
authSocialConnectCreate POST /api/v1/auth/social/connect/
authSocialCreate POST /api/v1/auth/social/
authTokenBlacklistCreate POST /api/v1/auth/token/blacklist/
authTokenCreate POST /api/v1/auth/token/
authTokenRefreshCreate POST /api/v1/auth/token/refresh/
authTokenVerifyCreate POST /api/v1/auth/token/verify/
authUsersCreate POST /api/v1/auth/users/
authUsersPartialUpdate PATCH /api/v1/auth/users/{id}/
authUsersRetrieve GET /api/v1/auth/users/{id}/
authUsersSetPasswordCreate POST /api/v1/auth/users/{id}/set-password/
authUsersTwoFaPartialUpdate PATCH /api/v1/auth/users/{id}/two-fa/
authUsersTwoFaRetrieve GET /api/v1/auth/users/{id}/two-fa/

authOtpCreate

OTPObtain authOtpCreate(oTPObtainRequest)

Example

import 'package:djangoflow_openapi/api.dart';
// TODO Configure HTTP basic authorization: jwtAuth
//defaultApiClient.getAuthentication<HttpBasicAuth>('jwtAuth').username = 'YOUR_USERNAME'
//defaultApiClient.getAuthentication<HttpBasicAuth>('jwtAuth').password = 'YOUR_PASSWORD';

final api = DjangoflowOpenapi().getAuthApi();
final OTPObtainRequest oTPObtainRequest = ; // OTPObtainRequest | 

try {
    final response = api.authOtpCreate(oTPObtainRequest);
    print(response);
} catch on DioError (e) {
    print('Exception when calling AuthApi->authOtpCreate: $e\n');
}

Parameters

Name Type Description Notes
oTPObtainRequest OTPObtainRequest [optional]

Return type

OTPObtain

Authorization

jwtAuth

HTTP request headers

  • Content-Type: application/json, application/x-www-form-urlencoded, multipart/form-data
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

authOtpDevicesConfirmCreate

authOtpDevicesConfirmCreate(id, type, oTPDeviceConfirmRequest)

Example

import 'package:djangoflow_openapi/api.dart';
// TODO Configure HTTP basic authorization: jwtAuth
//defaultApiClient.getAuthentication<HttpBasicAuth>('jwtAuth').username = 'YOUR_USERNAME'
//defaultApiClient.getAuthentication<HttpBasicAuth>('jwtAuth').password = 'YOUR_PASSWORD';

final api = DjangoflowOpenapi().getAuthApi();
final String id = id_example; // String | 
final String type = type_example; // String | OTP Device type
final OTPDeviceConfirmRequest oTPDeviceConfirmRequest = ; // OTPDeviceConfirmRequest | 

try {
    api.authOtpDevicesConfirmCreate(id, type, oTPDeviceConfirmRequest);
} catch on DioError (e) {
    print('Exception when calling AuthApi->authOtpDevicesConfirmCreate: $e\n');
}

Parameters

Name Type Description Notes
id String
type String OTP Device type
oTPDeviceConfirmRequest OTPDeviceConfirmRequest

Return type

void (empty response body)

Authorization

jwtAuth

HTTP request headers

  • Content-Type: application/json, application/x-www-form-urlencoded, multipart/form-data
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

authOtpDevicesCreate

OTPDevice authOtpDevicesCreate(oTPDeviceRequest)

Example

import 'package:djangoflow_openapi/api.dart';
// TODO Configure HTTP basic authorization: jwtAuth
//defaultApiClient.getAuthentication<HttpBasicAuth>('jwtAuth').username = 'YOUR_USERNAME'
//defaultApiClient.getAuthentication<HttpBasicAuth>('jwtAuth').password = 'YOUR_PASSWORD';

final api = DjangoflowOpenapi().getAuthApi();
final OTPDeviceRequest oTPDeviceRequest = ; // OTPDeviceRequest | 

try {
    final response = api.authOtpDevicesCreate(oTPDeviceRequest);
    print(response);
} catch on DioError (e) {
    print('Exception when calling AuthApi->authOtpDevicesCreate: $e\n');
}

Parameters

Name Type Description Notes
oTPDeviceRequest OTPDeviceRequest

Return type

OTPDevice

Authorization

jwtAuth

HTTP request headers

  • Content-Type: application/json, application/x-www-form-urlencoded, multipart/form-data
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

authOtpDevicesDestroy

authOtpDevicesDestroy(id, type)

Example

import 'package:djangoflow_openapi/api.dart';
// TODO Configure HTTP basic authorization: jwtAuth
//defaultApiClient.getAuthentication<HttpBasicAuth>('jwtAuth').username = 'YOUR_USERNAME'
//defaultApiClient.getAuthentication<HttpBasicAuth>('jwtAuth').password = 'YOUR_PASSWORD';

final api = DjangoflowOpenapi().getAuthApi();
final String id = id_example; // String | 
final String type = type_example; // String | OTP Device type

try {
    api.authOtpDevicesDestroy(id, type);
} catch on DioError (e) {
    print('Exception when calling AuthApi->authOtpDevicesDestroy: $e\n');
}

Parameters

Name Type Description Notes
id String
type String OTP Device type

Return type

void (empty response body)

Authorization

jwtAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

authOtpDevicesList

PaginatedOTPDeviceList authOtpDevicesList(limit, offset)

Example

import 'package:djangoflow_openapi/api.dart';
// TODO Configure HTTP basic authorization: jwtAuth
//defaultApiClient.getAuthentication<HttpBasicAuth>('jwtAuth').username = 'YOUR_USERNAME'
//defaultApiClient.getAuthentication<HttpBasicAuth>('jwtAuth').password = 'YOUR_PASSWORD';

final api = DjangoflowOpenapi().getAuthApi();
final int limit = 56; // int | Number of results to return per page.
final int offset = 56; // int | The initial index from which to return the results.

try {
    final response = api.authOtpDevicesList(limit, offset);
    print(response);
} catch on DioError (e) {
    print('Exception when calling AuthApi->authOtpDevicesList: $e\n');
}

Parameters

Name Type Description Notes
limit int Number of results to return per page. [optional]
offset int The initial index from which to return the results. [optional]

Return type

PaginatedOTPDeviceList

Authorization

jwtAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

authOtpDevicesRetrieve

OTPDevice authOtpDevicesRetrieve(id, type)

Example

import 'package:djangoflow_openapi/api.dart';
// TODO Configure HTTP basic authorization: jwtAuth
//defaultApiClient.getAuthentication<HttpBasicAuth>('jwtAuth').username = 'YOUR_USERNAME'
//defaultApiClient.getAuthentication<HttpBasicAuth>('jwtAuth').password = 'YOUR_PASSWORD';

final api = DjangoflowOpenapi().getAuthApi();
final String id = id_example; // String | 
final String type = type_example; // String | OTP Device type

try {
    final response = api.authOtpDevicesRetrieve(id, type);
    print(response);
} catch on DioError (e) {
    print('Exception when calling AuthApi->authOtpDevicesRetrieve: $e\n');
}

Parameters

Name Type Description Notes
id String
type String OTP Device type

Return type

OTPDevice

Authorization

jwtAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

authSocialConnectCreate

Token authSocialConnectCreate(socialTokenObtainRequest)

Example

import 'package:djangoflow_openapi/api.dart';
// TODO Configure HTTP basic authorization: jwtAuth
//defaultApiClient.getAuthentication<HttpBasicAuth>('jwtAuth').username = 'YOUR_USERNAME'
//defaultApiClient.getAuthentication<HttpBasicAuth>('jwtAuth').password = 'YOUR_PASSWORD';

final api = DjangoflowOpenapi().getAuthApi();
final SocialTokenObtainRequest socialTokenObtainRequest = ; // SocialTokenObtainRequest | 

try {
    final response = api.authSocialConnectCreate(socialTokenObtainRequest);
    print(response);
} catch on DioError (e) {
    print('Exception when calling AuthApi->authSocialConnectCreate: $e\n');
}

Parameters

Name Type Description Notes
socialTokenObtainRequest SocialTokenObtainRequest

Return type

Token

Authorization

jwtAuth

HTTP request headers

  • Content-Type: application/json, application/x-www-form-urlencoded, multipart/form-data
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

authSocialCreate

Token authSocialCreate(socialTokenObtainRequest)

Example

import 'package:djangoflow_openapi/api.dart';
// TODO Configure HTTP basic authorization: jwtAuth
//defaultApiClient.getAuthentication<HttpBasicAuth>('jwtAuth').username = 'YOUR_USERNAME'
//defaultApiClient.getAuthentication<HttpBasicAuth>('jwtAuth').password = 'YOUR_PASSWORD';

final api = DjangoflowOpenapi().getAuthApi();
final SocialTokenObtainRequest socialTokenObtainRequest = ; // SocialTokenObtainRequest | 

try {
    final response = api.authSocialCreate(socialTokenObtainRequest);
    print(response);
} catch on DioError (e) {
    print('Exception when calling AuthApi->authSocialCreate: $e\n');
}

Parameters

Name Type Description Notes
socialTokenObtainRequest SocialTokenObtainRequest

Return type

Token

Authorization

jwtAuth

HTTP request headers

  • Content-Type: application/json, application/x-www-form-urlencoded, multipart/form-data
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

authTokenBlacklistCreate

Token authTokenBlacklistCreate(tokenBlacklistRequest)

Example

import 'package:djangoflow_openapi/api.dart';
// TODO Configure HTTP basic authorization: jwtAuth
//defaultApiClient.getAuthentication<HttpBasicAuth>('jwtAuth').username = 'YOUR_USERNAME'
//defaultApiClient.getAuthentication<HttpBasicAuth>('jwtAuth').password = 'YOUR_PASSWORD';

final api = DjangoflowOpenapi().getAuthApi();
final TokenBlacklistRequest tokenBlacklistRequest = ; // TokenBlacklistRequest | 

try {
    final response = api.authTokenBlacklistCreate(tokenBlacklistRequest);
    print(response);
} catch on DioError (e) {
    print('Exception when calling AuthApi->authTokenBlacklistCreate: $e\n');
}

Parameters

Name Type Description Notes
tokenBlacklistRequest TokenBlacklistRequest

Return type

Token

Authorization

jwtAuth

HTTP request headers

  • Content-Type: application/json, application/x-www-form-urlencoded, multipart/form-data
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

authTokenCreate

Token authTokenCreate(tokenObtainRequest)

Example

import 'package:djangoflow_openapi/api.dart';
// TODO Configure HTTP basic authorization: jwtAuth
//defaultApiClient.getAuthentication<HttpBasicAuth>('jwtAuth').username = 'YOUR_USERNAME'
//defaultApiClient.getAuthentication<HttpBasicAuth>('jwtAuth').password = 'YOUR_PASSWORD';

final api = DjangoflowOpenapi().getAuthApi();
final TokenObtainRequest tokenObtainRequest = ; // TokenObtainRequest | 

try {
    final response = api.authTokenCreate(tokenObtainRequest);
    print(response);
} catch on DioError (e) {
    print('Exception when calling AuthApi->authTokenCreate: $e\n');
}

Parameters

Name Type Description Notes
tokenObtainRequest TokenObtainRequest [optional]

Return type

Token

Authorization

jwtAuth

HTTP request headers

  • Content-Type: application/json, application/x-www-form-urlencoded, multipart/form-data
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

authTokenRefreshCreate

Token authTokenRefreshCreate(tokenRefreshRequest)

Example

import 'package:djangoflow_openapi/api.dart';
// TODO Configure HTTP basic authorization: jwtAuth
//defaultApiClient.getAuthentication<HttpBasicAuth>('jwtAuth').username = 'YOUR_USERNAME'
//defaultApiClient.getAuthentication<HttpBasicAuth>('jwtAuth').password = 'YOUR_PASSWORD';

final api = DjangoflowOpenapi().getAuthApi();
final TokenRefreshRequest tokenRefreshRequest = ; // TokenRefreshRequest | 

try {
    final response = api.authTokenRefreshCreate(tokenRefreshRequest);
    print(response);
} catch on DioError (e) {
    print('Exception when calling AuthApi->authTokenRefreshCreate: $e\n');
}

Parameters

Name Type Description Notes
tokenRefreshRequest TokenRefreshRequest

Return type

Token

Authorization

jwtAuth

HTTP request headers

  • Content-Type: application/json, application/x-www-form-urlencoded, multipart/form-data
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

authTokenVerifyCreate

Token authTokenVerifyCreate(tokenVerifyRequest)

Example

import 'package:djangoflow_openapi/api.dart';
// TODO Configure HTTP basic authorization: jwtAuth
//defaultApiClient.getAuthentication<HttpBasicAuth>('jwtAuth').username = 'YOUR_USERNAME'
//defaultApiClient.getAuthentication<HttpBasicAuth>('jwtAuth').password = 'YOUR_PASSWORD';

final api = DjangoflowOpenapi().getAuthApi();
final TokenVerifyRequest tokenVerifyRequest = ; // TokenVerifyRequest | 

try {
    final response = api.authTokenVerifyCreate(tokenVerifyRequest);
    print(response);
} catch on DioError (e) {
    print('Exception when calling AuthApi->authTokenVerifyCreate: $e\n');
}

Parameters

Name Type Description Notes
tokenVerifyRequest TokenVerifyRequest

Return type

Token

Authorization

jwtAuth

HTTP request headers

  • Content-Type: application/json, application/x-www-form-urlencoded, multipart/form-data
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

authUsersCreate

UserIdentity authUsersCreate(userIdentityRequest)

Example

import 'package:djangoflow_openapi/api.dart';
// TODO Configure HTTP basic authorization: jwtAuth
//defaultApiClient.getAuthentication<HttpBasicAuth>('jwtAuth').username = 'YOUR_USERNAME'
//defaultApiClient.getAuthentication<HttpBasicAuth>('jwtAuth').password = 'YOUR_PASSWORD';

final api = DjangoflowOpenapi().getAuthApi();
final UserIdentityRequest userIdentityRequest = ; // UserIdentityRequest | 

try {
    final response = api.authUsersCreate(userIdentityRequest);
    print(response);
} catch on DioError (e) {
    print('Exception when calling AuthApi->authUsersCreate: $e\n');
}

Parameters

Name Type Description Notes
userIdentityRequest UserIdentityRequest [optional]

Return type

UserIdentity

Authorization

jwtAuth

HTTP request headers

  • Content-Type: application/json, application/x-www-form-urlencoded, multipart/form-data
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

authUsersPartialUpdate

UserIdentity authUsersPartialUpdate(id, patchedUserIdentityRequest)

Example

import 'package:djangoflow_openapi/api.dart';
// TODO Configure HTTP basic authorization: jwtAuth
//defaultApiClient.getAuthentication<HttpBasicAuth>('jwtAuth').username = 'YOUR_USERNAME'
//defaultApiClient.getAuthentication<HttpBasicAuth>('jwtAuth').password = 'YOUR_PASSWORD';

final api = DjangoflowOpenapi().getAuthApi();
final String id = id_example; // String | 
final PatchedUserIdentityRequest patchedUserIdentityRequest = ; // PatchedUserIdentityRequest | 

try {
    final response = api.authUsersPartialUpdate(id, patchedUserIdentityRequest);
    print(response);
} catch on DioError (e) {
    print('Exception when calling AuthApi->authUsersPartialUpdate: $e\n');
}

Parameters

Name Type Description Notes
id String
patchedUserIdentityRequest PatchedUserIdentityRequest [optional]

Return type

UserIdentity

Authorization

jwtAuth

HTTP request headers

  • Content-Type: application/json, application/x-www-form-urlencoded, multipart/form-data
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

authUsersRetrieve

UserIdentity authUsersRetrieve(id)

Example

import 'package:djangoflow_openapi/api.dart';
// TODO Configure HTTP basic authorization: jwtAuth
//defaultApiClient.getAuthentication<HttpBasicAuth>('jwtAuth').username = 'YOUR_USERNAME'
//defaultApiClient.getAuthentication<HttpBasicAuth>('jwtAuth').password = 'YOUR_PASSWORD';

final api = DjangoflowOpenapi().getAuthApi();
final String id = id_example; // String | 

try {
    final response = api.authUsersRetrieve(id);
    print(response);
} catch on DioError (e) {
    print('Exception when calling AuthApi->authUsersRetrieve: $e\n');
}

Parameters

Name Type Description Notes
id String

Return type

UserIdentity

Authorization

jwtAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

authUsersSetPasswordCreate

authUsersSetPasswordCreate(id, changePasswordRequest)

Example

import 'package:djangoflow_openapi/api.dart';
// TODO Configure HTTP basic authorization: jwtAuth
//defaultApiClient.getAuthentication<HttpBasicAuth>('jwtAuth').username = 'YOUR_USERNAME'
//defaultApiClient.getAuthentication<HttpBasicAuth>('jwtAuth').password = 'YOUR_PASSWORD';

final api = DjangoflowOpenapi().getAuthApi();
final String id = id_example; // String | 
final ChangePasswordRequest changePasswordRequest = ; // ChangePasswordRequest | 

try {
    api.authUsersSetPasswordCreate(id, changePasswordRequest);
} catch on DioError (e) {
    print('Exception when calling AuthApi->authUsersSetPasswordCreate: $e\n');
}

Parameters

Name Type Description Notes
id String
changePasswordRequest ChangePasswordRequest

Return type

void (empty response body)

Authorization

jwtAuth

HTTP request headers

  • Content-Type: application/json, application/x-www-form-urlencoded, multipart/form-data
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

authUsersTwoFaPartialUpdate

User2FA authUsersTwoFaPartialUpdate(id, patchedUser2FARequest)

Example

import 'package:djangoflow_openapi/api.dart';
// TODO Configure HTTP basic authorization: jwtAuth
//defaultApiClient.getAuthentication<HttpBasicAuth>('jwtAuth').username = 'YOUR_USERNAME'
//defaultApiClient.getAuthentication<HttpBasicAuth>('jwtAuth').password = 'YOUR_PASSWORD';

final api = DjangoflowOpenapi().getAuthApi();
final String id = id_example; // String | 
final PatchedUser2FARequest patchedUser2FARequest = ; // PatchedUser2FARequest | 

try {
    final response = api.authUsersTwoFaPartialUpdate(id, patchedUser2FARequest);
    print(response);
} catch on DioError (e) {
    print('Exception when calling AuthApi->authUsersTwoFaPartialUpdate: $e\n');
}

Parameters

Name Type Description Notes
id String
patchedUser2FARequest PatchedUser2FARequest [optional]

Return type

User2FA

Authorization

jwtAuth

HTTP request headers

  • Content-Type: application/json, application/x-www-form-urlencoded, multipart/form-data
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

authUsersTwoFaRetrieve

User2FA authUsersTwoFaRetrieve(id)

Example

import 'package:djangoflow_openapi/api.dart';
// TODO Configure HTTP basic authorization: jwtAuth
//defaultApiClient.getAuthentication<HttpBasicAuth>('jwtAuth').username = 'YOUR_USERNAME'
//defaultApiClient.getAuthentication<HttpBasicAuth>('jwtAuth').password = 'YOUR_PASSWORD';

final api = DjangoflowOpenapi().getAuthApi();
final String id = id_example; // String | 

try {
    final response = api.authUsersTwoFaRetrieve(id);
    print(response);
} catch on DioError (e) {
    print('Exception when calling AuthApi->authUsersTwoFaRetrieve: $e\n');
}

Parameters

Name Type Description Notes
id String

Return type

User2FA

Authorization

jwtAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]