orvanta-api 6.4.0

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228

# \SettingsApi

All URIs are relative to */api*

Method | HTTP request | Description
------------- | ------------- | -------------
[**backend_version**](SettingsApi.md#backend_version) | **GET** /version | get backend version
[**get_brand_name**](SettingsApi.md#get_brand_name) | **GET** /brand_name | get the public brand name
[**get_entitlements**](SettingsApi.md#get_entitlements) | **GET** /entitlements | get the instance (host) licence's tier and limits
[**get_license_id**](SettingsApi.md#get_license_id) | **GET** /ee_license | get license id
[**get_open_api_yaml**](SettingsApi.md#get_open_api_yaml) | **GET** /openapi.yaml | get openapi yaml spec
[**get_workspace_entitlements**](SettingsApi.md#get_workspace_entitlements) | **GET** /w/{workspace}/entitlements | get the licence answering for this workspace
[**list_features**](SettingsApi.md#list_features) | **GET** /features | list enabled feature keys, the ORVANTA_BETA toggle, and the capability catalog
[**list_workspace_features**](SettingsApi.md#list_workspace_features) | **GET** /w/{workspace}/features | list this workspace's enabled feature keys and capability catalog



## backend_version

> String backend_version()
get backend version

### Parameters

This endpoint does not need any parameter.

### Return type

**String**

### Authorization

[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: text/plain

[[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)


## get_brand_name

> String get_brand_name()
get the public brand name

The operator-set whitelabel name for pre-login pages. Unauthenticated; exposes only the sanitized (max 40 chars) `whitelabel_name` instance setting, never licence data.

### Parameters

This endpoint does not need any parameter.

### Return type

**String**

### Authorization

[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: text/plain

[[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)


## get_entitlements

> models::GetEntitlements200Response get_entitlements()
get the instance (host) licence's tier and limits

### Parameters

This endpoint does not need any parameter.

### Return type

[**models::GetEntitlements200Response**](getEntitlements_200_response.md)

### Authorization

[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

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

[[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)


## get_license_id

> String get_license_id()
get license id

### Parameters

This endpoint does not need any parameter.

### Return type

**String**

### Authorization

[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: text/plain

[[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)


## get_open_api_yaml

> String get_open_api_yaml()
get openapi yaml spec

### Parameters

This endpoint does not need any parameter.

### Return type

**String**

### Authorization

[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: text/plain

[[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)


## get_workspace_entitlements

> models::WorkspaceEntitlements get_workspace_entitlements(workspace)
get the licence answering for this workspace

Read-only (#1753). Managed licence mode: the workspace's own licence (Trial and `state: missing` when none is held). Instance mode: the instance licence, shared by every workspace. Members of the workspace only; a non-member is refused exactly as for a workspace that does not exist. Seat allowances/usage and the ladder dates (`seats`, `seats_used`, `first_failure_at`, `grace_deadline`, `missing_since`) are returned to workspace admins only and are `null` for other members (#1953).

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |

### Return type

[**models::WorkspaceEntitlements**](WorkspaceEntitlements.md)

### Authorization

[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

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

[[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)


## list_features

> models::FeatureCatalogResponse list_features()
list enabled feature keys, the ORVANTA_BETA toggle, and the capability catalog

### Parameters

This endpoint does not need any parameter.

### Return type

[**models::FeatureCatalogResponse**](FeatureCatalogResponse.md)

### Authorization

No authorization required

### HTTP request headers

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

[[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)


## list_workspace_features

> models::FeatureCatalogResponse list_workspace_features(workspace)
list this workspace's enabled feature keys and capability catalog

Same shape as `/features`, answered by the licence of this workspace (#1753): its own for a workspace-scoped capability in managed licence mode (Trial when none is held), the host's for an instance-scoped one, and the instance licence for everything in instance mode. Members of the workspace only.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |

### Return type

[**models::FeatureCatalogResponse**](FeatureCatalogResponse.md)

### Authorization

[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

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

[[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)