|
| 1 | +# flexify_api.AuthSsoControllerApi |
| 2 | + |
| 3 | +All URIs are relative to *https://api.flexify.io* |
| 4 | + |
| 5 | +Method | HTTP request | Description |
| 6 | +------------- | ------------- | ------------- |
| 7 | +[**get_config**](AuthSsoControllerApi.md#get_config) | **GET** /backend/rest/auth/sso/config | getConfig |
| 8 | +[**get_device_code**](AuthSsoControllerApi.md#get_device_code) | **GET** /backend/rest/auth/sso/device-code | getDeviceCode |
| 9 | +[**get_token_by_device_code**](AuthSsoControllerApi.md#get_token_by_device_code) | **POST** /backend/rest/auth/sso/token-by-device-code | getTokenByDeviceCode |
| 10 | +[**refresh_token_for_device_code_flow**](AuthSsoControllerApi.md#refresh_token_for_device_code_flow) | **POST** /backend/rest/auth/sso/token-refresh | refreshTokenForDeviceCodeFlow |
| 11 | + |
| 12 | + |
| 13 | +# **get_config** |
| 14 | +> MicrosoftOAuthConfig get_config(oauth_provider_id) |
| 15 | +
|
| 16 | +getConfig |
| 17 | + |
| 18 | +### Example |
| 19 | +```python |
| 20 | +from __future__ import print_function |
| 21 | +import time |
| 22 | +import flexify_api |
| 23 | +from flexify_api.rest import ApiException |
| 24 | +from pprint import pprint |
| 25 | + |
| 26 | +# Configure API key authorization: Bearer |
| 27 | +configuration = flexify_api.Configuration() |
| 28 | +configuration.api_key['Authorization'] = 'YOUR_API_KEY' |
| 29 | +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed |
| 30 | +# configuration.api_key_prefix['Authorization'] = 'Bearer' |
| 31 | + |
| 32 | +# create an instance of the API class |
| 33 | +api_instance = flexify_api.AuthSsoControllerApi(flexify_api.ApiClient(configuration)) |
| 34 | +oauth_provider_id = 'oauth_provider_id_example' # str | oauth-provider-id |
| 35 | + |
| 36 | +try: |
| 37 | + # getConfig |
| 38 | + api_response = api_instance.get_config(oauth_provider_id) |
| 39 | + pprint(api_response) |
| 40 | +except ApiException as e: |
| 41 | + print("Exception when calling AuthSsoControllerApi->get_config: %s\n" % e) |
| 42 | +``` |
| 43 | + |
| 44 | +### Parameters |
| 45 | + |
| 46 | +Name | Type | Description | Notes |
| 47 | +------------- | ------------- | ------------- | ------------- |
| 48 | + **oauth_provider_id** | **str**| oauth-provider-id | |
| 49 | + |
| 50 | +### Return type |
| 51 | + |
| 52 | +[**MicrosoftOAuthConfig**](MicrosoftOAuthConfig.md) |
| 53 | + |
| 54 | +### Authorization |
| 55 | + |
| 56 | +[Bearer](../README.md#Bearer) |
| 57 | + |
| 58 | +### HTTP request headers |
| 59 | + |
| 60 | + - **Content-Type**: Not defined |
| 61 | + - **Accept**: */* |
| 62 | + |
| 63 | +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) |
| 64 | + |
| 65 | +# **get_device_code** |
| 66 | +> OAuth2DeviceCodeResponse get_device_code(oauth_provider_id) |
| 67 | +
|
| 68 | +getDeviceCode |
| 69 | + |
| 70 | +### Example |
| 71 | +```python |
| 72 | +from __future__ import print_function |
| 73 | +import time |
| 74 | +import flexify_api |
| 75 | +from flexify_api.rest import ApiException |
| 76 | +from pprint import pprint |
| 77 | + |
| 78 | +# Configure API key authorization: Bearer |
| 79 | +configuration = flexify_api.Configuration() |
| 80 | +configuration.api_key['Authorization'] = 'YOUR_API_KEY' |
| 81 | +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed |
| 82 | +# configuration.api_key_prefix['Authorization'] = 'Bearer' |
| 83 | + |
| 84 | +# create an instance of the API class |
| 85 | +api_instance = flexify_api.AuthSsoControllerApi(flexify_api.ApiClient(configuration)) |
| 86 | +oauth_provider_id = 'oauth_provider_id_example' # str | oauth-provider-id |
| 87 | + |
| 88 | +try: |
| 89 | + # getDeviceCode |
| 90 | + api_response = api_instance.get_device_code(oauth_provider_id) |
| 91 | + pprint(api_response) |
| 92 | +except ApiException as e: |
| 93 | + print("Exception when calling AuthSsoControllerApi->get_device_code: %s\n" % e) |
| 94 | +``` |
| 95 | + |
| 96 | +### Parameters |
| 97 | + |
| 98 | +Name | Type | Description | Notes |
| 99 | +------------- | ------------- | ------------- | ------------- |
| 100 | + **oauth_provider_id** | **str**| oauth-provider-id | |
| 101 | + |
| 102 | +### Return type |
| 103 | + |
| 104 | +[**OAuth2DeviceCodeResponse**](OAuth2DeviceCodeResponse.md) |
| 105 | + |
| 106 | +### Authorization |
| 107 | + |
| 108 | +[Bearer](../README.md#Bearer) |
| 109 | + |
| 110 | +### HTTP request headers |
| 111 | + |
| 112 | + - **Content-Type**: Not defined |
| 113 | + - **Accept**: */* |
| 114 | + |
| 115 | +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) |
| 116 | + |
| 117 | +# **get_token_by_device_code** |
| 118 | +> OAuthToken get_token_by_device_code(request) |
| 119 | +
|
| 120 | +getTokenByDeviceCode |
| 121 | + |
| 122 | +### Example |
| 123 | +```python |
| 124 | +from __future__ import print_function |
| 125 | +import time |
| 126 | +import flexify_api |
| 127 | +from flexify_api.rest import ApiException |
| 128 | +from pprint import pprint |
| 129 | + |
| 130 | +# Configure API key authorization: Bearer |
| 131 | +configuration = flexify_api.Configuration() |
| 132 | +configuration.api_key['Authorization'] = 'YOUR_API_KEY' |
| 133 | +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed |
| 134 | +# configuration.api_key_prefix['Authorization'] = 'Bearer' |
| 135 | + |
| 136 | +# create an instance of the API class |
| 137 | +api_instance = flexify_api.AuthSsoControllerApi(flexify_api.ApiClient(configuration)) |
| 138 | +request = flexify_api.TokenByDeviceCodeRequest() # TokenByDeviceCodeRequest | request |
| 139 | + |
| 140 | +try: |
| 141 | + # getTokenByDeviceCode |
| 142 | + api_response = api_instance.get_token_by_device_code(request) |
| 143 | + pprint(api_response) |
| 144 | +except ApiException as e: |
| 145 | + print("Exception when calling AuthSsoControllerApi->get_token_by_device_code: %s\n" % e) |
| 146 | +``` |
| 147 | + |
| 148 | +### Parameters |
| 149 | + |
| 150 | +Name | Type | Description | Notes |
| 151 | +------------- | ------------- | ------------- | ------------- |
| 152 | + **request** | [**TokenByDeviceCodeRequest**](TokenByDeviceCodeRequest.md)| request | |
| 153 | + |
| 154 | +### Return type |
| 155 | + |
| 156 | +[**OAuthToken**](OAuthToken.md) |
| 157 | + |
| 158 | +### Authorization |
| 159 | + |
| 160 | +[Bearer](../README.md#Bearer) |
| 161 | + |
| 162 | +### HTTP request headers |
| 163 | + |
| 164 | + - **Content-Type**: application/json |
| 165 | + - **Accept**: */* |
| 166 | + |
| 167 | +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) |
| 168 | + |
| 169 | +# **refresh_token_for_device_code_flow** |
| 170 | +> OAuthToken refresh_token_for_device_code_flow(request) |
| 171 | +
|
| 172 | +refreshTokenForDeviceCodeFlow |
| 173 | + |
| 174 | +### Example |
| 175 | +```python |
| 176 | +from __future__ import print_function |
| 177 | +import time |
| 178 | +import flexify_api |
| 179 | +from flexify_api.rest import ApiException |
| 180 | +from pprint import pprint |
| 181 | + |
| 182 | +# Configure API key authorization: Bearer |
| 183 | +configuration = flexify_api.Configuration() |
| 184 | +configuration.api_key['Authorization'] = 'YOUR_API_KEY' |
| 185 | +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed |
| 186 | +# configuration.api_key_prefix['Authorization'] = 'Bearer' |
| 187 | + |
| 188 | +# create an instance of the API class |
| 189 | +api_instance = flexify_api.AuthSsoControllerApi(flexify_api.ApiClient(configuration)) |
| 190 | +request = flexify_api.RefreshTokenRequest() # RefreshTokenRequest | request |
| 191 | + |
| 192 | +try: |
| 193 | + # refreshTokenForDeviceCodeFlow |
| 194 | + api_response = api_instance.refresh_token_for_device_code_flow(request) |
| 195 | + pprint(api_response) |
| 196 | +except ApiException as e: |
| 197 | + print("Exception when calling AuthSsoControllerApi->refresh_token_for_device_code_flow: %s\n" % e) |
| 198 | +``` |
| 199 | + |
| 200 | +### Parameters |
| 201 | + |
| 202 | +Name | Type | Description | Notes |
| 203 | +------------- | ------------- | ------------- | ------------- |
| 204 | + **request** | [**RefreshTokenRequest**](RefreshTokenRequest.md)| request | |
| 205 | + |
| 206 | +### Return type |
| 207 | + |
| 208 | +[**OAuthToken**](OAuthToken.md) |
| 209 | + |
| 210 | +### Authorization |
| 211 | + |
| 212 | +[Bearer](../README.md#Bearer) |
| 213 | + |
| 214 | +### HTTP request headers |
| 215 | + |
| 216 | + - **Content-Type**: application/json |
| 217 | + - **Accept**: */* |
| 218 | + |
| 219 | +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) |
| 220 | + |
0 commit comments