Skip to content

Latest commit

 

History

History
306 lines (205 loc) · 9.94 KB

AuthProviderV1alpha1Api.md

File metadata and controls

306 lines (205 loc) · 9.94 KB

halo_client.api.AuthProviderV1alpha1Api

Load the API package

import 'package:halo_client/api.dart';

All URIs are relative to http://localhost:8091

Method HTTP request Description
createAuthProvider POST /apis/auth.halo.run/v1alpha1/authproviders
deleteAuthProvider DELETE /apis/auth.halo.run/v1alpha1/authproviders/{name}
getAuthProvider GET /apis/auth.halo.run/v1alpha1/authproviders/{name}
listAuthProvider GET /apis/auth.halo.run/v1alpha1/authproviders
patchAuthProvider PATCH /apis/auth.halo.run/v1alpha1/authproviders/{name}
updateAuthProvider PUT /apis/auth.halo.run/v1alpha1/authproviders/{name}

createAuthProvider

AuthProvider createAuthProvider(authProvider)

Create AuthProvider

Example

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

final api = HaloClient().getAuthProviderV1alpha1Api();
final AuthProvider authProvider = ; // AuthProvider | Fresh authprovider

try {
    final response = api.createAuthProvider(authProvider);
    print(response);
} catch on DioException (e) {
    print('Exception when calling AuthProviderV1alpha1Api->createAuthProvider: $e\n');
}

Parameters

Name Type Description Notes
authProvider AuthProvider Fresh authprovider [optional]

Return type

AuthProvider

Authorization

basicAuth, bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

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

deleteAuthProvider

deleteAuthProvider(name)

Delete AuthProvider

Example

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

final api = HaloClient().getAuthProviderV1alpha1Api();
final String name = name_example; // String | Name of authprovider

try {
    api.deleteAuthProvider(name);
} catch on DioException (e) {
    print('Exception when calling AuthProviderV1alpha1Api->deleteAuthProvider: $e\n');
}

Parameters

Name Type Description Notes
name String Name of authprovider

Return type

void (empty response body)

Authorization

basicAuth, bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

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

getAuthProvider

AuthProvider getAuthProvider(name)

Get AuthProvider

Example

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

final api = HaloClient().getAuthProviderV1alpha1Api();
final String name = name_example; // String | Name of authprovider

try {
    final response = api.getAuthProvider(name);
    print(response);
} catch on DioException (e) {
    print('Exception when calling AuthProviderV1alpha1Api->getAuthProvider: $e\n');
}

Parameters

Name Type Description Notes
name String Name of authprovider

Return type

AuthProvider

Authorization

basicAuth, bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

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

listAuthProvider

AuthProviderList listAuthProvider(page, size, labelSelector, fieldSelector, sort)

List AuthProvider

Example

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

final api = HaloClient().getAuthProviderV1alpha1Api();
final int page = 56; // int | Page number. Default is 0.
final int size = 56; // int | Size number. Default is 0.
final BuiltList<String> labelSelector = ; // BuiltList<String> | Label selector. e.g.: hidden!=true
final BuiltList<String> fieldSelector = ; // BuiltList<String> | Field selector. e.g.: metadata.name==halo
final BuiltList<String> sort = ; // BuiltList<String> | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.

try {
    final response = api.listAuthProvider(page, size, labelSelector, fieldSelector, sort);
    print(response);
} catch on DioException (e) {
    print('Exception when calling AuthProviderV1alpha1Api->listAuthProvider: $e\n');
}

Parameters

Name Type Description Notes
page int Page number. Default is 0. [optional]
size int Size number. Default is 0. [optional]
labelSelector BuiltList<String> Label selector. e.g.: hidden!=true [optional]
fieldSelector BuiltList<String> Field selector. e.g.: metadata.name==halo [optional]
sort BuiltList<String> Sorting criteria in the format: property,(asc desc). Default sort order is ascending. Multiple sort criteria are supported.

Return type

AuthProviderList

Authorization

basicAuth, bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

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

patchAuthProvider

AuthProvider patchAuthProvider(name, jsonPatchInner)

Patch AuthProvider

Example

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

final api = HaloClient().getAuthProviderV1alpha1Api();
final String name = name_example; // String | Name of authprovider
final BuiltSet<JsonPatchInner> jsonPatchInner = ; // BuiltSet<JsonPatchInner> | 

try {
    final response = api.patchAuthProvider(name, jsonPatchInner);
    print(response);
} catch on DioException (e) {
    print('Exception when calling AuthProviderV1alpha1Api->patchAuthProvider: $e\n');
}

Parameters

Name Type Description Notes
name String Name of authprovider
jsonPatchInner BuiltSet<JsonPatchInner> [optional]

Return type

AuthProvider

Authorization

basicAuth, bearerAuth

HTTP request headers

  • Content-Type: application/json-patch+json
  • Accept: /

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

updateAuthProvider

AuthProvider updateAuthProvider(name, authProvider)

Update AuthProvider

Example

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

final api = HaloClient().getAuthProviderV1alpha1Api();
final String name = name_example; // String | Name of authprovider
final AuthProvider authProvider = ; // AuthProvider | Updated authprovider

try {
    final response = api.updateAuthProvider(name, authProvider);
    print(response);
} catch on DioException (e) {
    print('Exception when calling AuthProviderV1alpha1Api->updateAuthProvider: $e\n');
}

Parameters

Name Type Description Notes
name String Name of authprovider
authProvider AuthProvider Updated authprovider [optional]

Return type

AuthProvider

Authorization

basicAuth, bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

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