ApiKeyControllerApi class

Constructors

ApiKeyControllerApi(Dio _dio, Serializers _serializers)

const

Properties

hashCode → int

The hash code for this object.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

deleteApiKey({required String id, CancelToken? cancelToken, Map<String, dynamic>? headers, Map<String, dynamic>? extra, ValidateStatus? validateStatus, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<void>>

Delete API key by ID (deleteApiKey) Deletes the API key. Referencing non-existing ApiKey Id will cause an error. Available for any authorized user.

enableApiKey({required String id, required bool enabledValue, CancelToken? cancelToken, Map<String, dynamic>? headers, Map<String, dynamic>? extra, ValidateStatus? validateStatus, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<ApiKeyInfo>>

Enable or disable API key (enableApiKey) Updates api key with enabled = true/false. Available for any authorized user.

getUserApiKeys({required String userId, required int pageSize, required int page, String? textSearch, String? sortProperty, String? sortOrder, CancelToken? cancelToken, Map<String, dynamic>? headers, Map<String, dynamic>? extra, ValidateStatus? validateStatus, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<PageDataApiKeyInfo>>

Get User Api Keys (getUserApiKeys) Returns a page of api keys owned by user. You can specify parameters to filter the results. The result is wrapped with PageData object that allows you to iterate over result set using pagination. See response schema for more details. Available for any authorized user.

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

saveApiKey({required ApiKeyInfo apiKeyInfo, CancelToken? cancelToken, Map<String, dynamic>? headers, Map<String, dynamic>? extra, ValidateStatus? validateStatus, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<ApiKey>>

Save API key for user (saveApiKey) Creates an API key for the given user and returns the token ONCE as 'ApiKey {value}'. Available for any authorized user.

toString() → String

A string representation of this object.

inherited

updateApiKeyDescription({required String id, String? body, CancelToken? cancelToken, Map<String, dynamic>? headers, Map<String, dynamic>? extra, ValidateStatus? validateStatus, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<ApiKeyInfo>>

Update API key Description Updates the description of the existing API key by apiKeyId. Only the description can be updated. Referencing a non-existing ApiKey Id will cause a 'Not Found' error. Available for any authorized user.

Operators

operator ==(Object other) → bool

The equality operator.

inherited