You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
[[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)
82
82
83
-
# **get_doc**
84
-
> get_doc()
83
+
# **get_alive_doc**
84
+
> get_alive_doc()
85
85
86
86
87
87
@@ -117,9 +117,9 @@ with hyperstack.ApiClient(configuration) as api_client:
117
117
api_instance = hyperstack.AliveApi(api_client)
118
118
119
119
try:
120
-
api_instance.get_doc()
120
+
api_instance.get_alive_doc()
121
121
exceptExceptionas e:
122
-
print("Exception when calling AliveApi->get_doc: %s\n"% e)
122
+
print("Exception when calling AliveApi->get_alive_doc: %s\n"% e)
[**delete_api_key**](ApiKeyApi.md#delete_api_key) | **DELETE** /api-key/{api_key_id} | Delete API Key
8
8
[**generate_api_key**](ApiKeyApi.md#generate_api_key) | **POST** /api-key/generate | Generate API Key
9
-
[**retrieve_api_key**](ApiKeyApi.md#retrieve_api_key) | **GET** /api-key | Retrieve API Keys
9
+
[**get_api_key**](ApiKeyApi.md#get_api_key) | **GET** /api-key | Retrieve API Keys
10
10
[**update_api_key**](ApiKeyApi.md#update_api_key) | **PUT** /api-key/{api_key_id} | Update API Key
11
11
12
12
@@ -167,8 +167,8 @@ No authorization required
167
167
168
168
[[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)
169
169
170
-
# **retrieve_api_key**
171
-
> GetApiKeysResponseModel retrieve_api_key()
170
+
# **get_api_key**
171
+
> GetApiKeysResponseModel get_api_key()
172
172
173
173
Retrieve API Keys
174
174
@@ -208,11 +208,11 @@ with hyperstack.ApiClient(configuration) as api_client:
208
208
209
209
try:
210
210
# Retrieve API Keys
211
-
api_response = api_instance.retrieve_api_key()
212
-
print("The response of ApiKeyApi->retrieve_api_key:\n")
211
+
api_response = api_instance.get_api_key()
212
+
print("The response of ApiKeyApi->get_api_key:\n")
213
213
pprint(api_response)
214
214
exceptExceptionas e:
215
-
print("Exception when calling ApiKeyApi->retrieve_api_key: %s\n"% e)
215
+
print("Exception when calling ApiKeyApi->get_api_key: %s\n"% e)
[**get_authenticated_user**](AuthApi.md#get_authenticated_user) | **GET** /auth/me | Retrieve Authenticated User Details
9
10
[**get_user_mfa_status**](AuthApi.md#get_user_mfa_status) | **GET** /auth/me/mfa | Get MFA status for authenticated user
10
11
[**get_user_organizations**](AuthApi.md#get_user_organizations) | **GET** /auth/me/organizations | Get User Organizations
11
-
[**retrieve_authenticated_user_details**](AuthApi.md#retrieve_authenticated_user_details) | **GET** /auth/me | Retrieve Authenticated User Details
12
12
13
13
14
14
# **change_organization_for_token**
@@ -170,20 +170,20 @@ This endpoint does not need any parameter.
170
170
171
171
[[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)
Retrieve the Multi-Factor Authentication (MFA) status for the currentlyauthenticated user. Includes whether MFA is enabled.
178
+
Retrieves detailed information about the currently authenticated user. For additional information, [**click here**](https://docs.hyperstack.cloud/docs/api-reference/auth-resources/auth).
179
179
180
180
### Example
181
181
182
182
* Api Key Authentication (apiKey):
183
183
184
184
```python
185
185
import hyperstack
186
-
from hyperstack.models.mfa_status_responseimportMFAStatusResponse
186
+
from hyperstack.models.auth_user_info_response_modelimportAuthUserInfoResponseModel
187
187
from hyperstack.rest import ApiException
188
188
from pprint import pprint
189
189
@@ -210,12 +210,12 @@ with hyperstack.ApiClient(configuration) as api_client:
210
210
api_instance = hyperstack.AuthApi(api_client)
211
211
212
212
try:
213
-
#Get MFA status for authenticated user
214
-
api_response = api_instance.get_user_mfa_status()
215
-
print("The response of AuthApi->get_user_mfa_status:\n")
@@ -241,27 +241,27 @@ This endpoint does not need any parameter.
241
241
242
242
| Status code | Description | Response headers |
243
243
|-------------|-------------|------------------|
244
-
**200** | MFA Status | - |
244
+
**200** | User Information | - |
245
+
**400** | Bad Request | - |
245
246
**401** | Unauthorized | - |
246
-
**404** | User not found | - |
247
247
**500** | Internal Server Error | - |
248
248
249
249
[[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)
@@ -319,28 +319,27 @@ This endpoint does not need any parameter.
319
319
320
320
| Status code | Description | Response headers |
321
321
|-------------|-------------|------------------|
322
-
**200** | Success | - |
323
-
**400** | Bad Request | - |
322
+
**200** | MFA Status | - |
324
323
**401** | Unauthorized | - |
325
-
**404** | Not Found | - |
324
+
**404** | User not found | - |
326
325
**500** | Internal Server Error | - |
327
326
328
327
[[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)
Retrieves detailed information about the currently authenticated user. For additional information, [**click here**](https://docs.hyperstack.cloud/docs/api-reference/auth-resources/auth).
334
+
Retrieve the organizations associated with a user by their user ID. This endpoint is useful for understanding the user's organizational affiliations.
336
335
337
336
### Example
338
337
339
338
* Api Key Authentication (apiKey):
340
339
341
340
```python
342
341
import hyperstack
343
-
from hyperstack.models.auth_user_info_response_modelimportAuthUserInfoResponseModel
342
+
from hyperstack.models.user_organizations_responseimportUserOrganizationsResponse
344
343
from hyperstack.rest import ApiException
345
344
from pprint import pprint
346
345
@@ -367,12 +366,12 @@ with hyperstack.ApiClient(configuration) as api_client:
@@ -398,9 +397,10 @@ This endpoint does not need any parameter.
398
397
399
398
| Status code | Description | Response headers |
400
399
|-------------|-------------|------------------|
401
-
**200** | User Information | - |
400
+
**200** | Success | - |
402
401
**400** | Bad Request | - |
403
402
**401** | Unauthorized | - |
403
+
**404** | Not Found | - |
404
404
**500** | Internal Server Error | - |
405
405
406
406
[[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)
Copy file name to clipboardExpand all lines: docs/BetaAccessApi.md
+29-29Lines changed: 29 additions & 29 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,13 +4,13 @@ All URIs are relative to *https://infrahub-api.nexgencloud.com/v1*
4
4
5
5
Method | HTTP request | Description
6
6
------------- | ------------- | -------------
7
-
[**create_a_beta_access_request**](BetaAccessApi.md#create_a_beta_access_request) | **POST** /auth/beta-access/requests | Create a new beta access request
7
+
[**create_beta_access_request**](BetaAccessApi.md#create_beta_access_request) | **POST** /auth/beta-access/requests | Create a new beta access request
8
+
[**get_beta_access_requests**](BetaAccessApi.md#get_beta_access_requests) | **GET** /auth/beta-access/requests/{program} | Check the status of beta access requests
8
9
[**get_beta_access_status**](BetaAccessApi.md#get_beta_access_status) | **GET** /auth/beta-access/requests | Check the status of all beta access requests
9
-
[**get_beta_access_status2**](BetaAccessApi.md#get_beta_access_status2) | **GET** /auth/beta-access/requests/{program} | Check the status of beta access requests
print("The response of BetaAccessApi->create_beta_access_request:\n")
57
57
pprint(api_response)
58
58
exceptExceptionas e:
59
-
print("Exception when calling BetaAccessApi->create_a_beta_access_request: %s\n"% e)
59
+
print("Exception when calling BetaAccessApi->create_beta_access_request: %s\n"% e)
60
60
```
61
61
62
62
@@ -93,12 +93,12 @@ Name | Type | Description | Notes
93
93
94
94
[[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)
@@ -172,12 +176,12 @@ This endpoint does not need any parameter.
172
176
173
177
[[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)
0 commit comments