ApplicationsApi
| Method | HTTP request | Description |
|---|---|---|
| createAdminApiApplicationUsingPOST | POST /api/web/v1/applications/adminapi | Create Admin API application |
| createAuthApiApplicationUsingPOST | POST /api/web/v1/applications/authapi | Create Auth API application |
| getAdminApiApplicationUsingGET | GET /api/web/v1/applications/adminapi/{id} | Get Admin API application |
| getAuthApiApplicationUsingGET | GET /api/web/v1/applications/authapi/{id} | Get Auth API application |
| listAdminApiApplicationsUsingGET | GET /api/web/v1/applications/adminapi | List Admin API application |
| listApplicationInfoUsingGET | GET /api/web/v1/applicationinfo | List application information |
| listApplicationTemplatesUsingGET | GET /api/web/v1/applications/templates | List application templates |
| listAuthApiApplicationsUsingGET | GET /api/web/v1/applications/authapi | List Auth API applications |
| removeAdminApiApplicationUsingDELETE | DELETE /api/web/v1/applications/adminapi/{id} | Remove Admin API application |
| removeAuthApiApplicationUsingDELETE | DELETE /api/web/v1/applications/authapi/{id} | Remove Auth API application |
| updateAdminApiApplicationUsingPUT | PUT /api/web/v1/applications/adminapi/{id} | Update Admin API application |
| updateAdminApiSharedSecretUsingPUT | PUT /api/web/v1/applications/adminapi/regenerate/{id} | Regenerate Admin API application shared secret |
| updateAuthApiApplicationUsingPUT | PUT /api/web/v1/applications/authapi/{id} | Update Auth API application |
createAdminApiApplicationUsingPOST
AdminApiApplication createAdminApiApplicationUsingPOST(adminApiApplicationParms)
Create Admin API application
Create an Admin API application. Caller requires the APPLICATIONS:ADD permission.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| adminApiApplicationParms | AdminApiApplicationParms |
Return type
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful | - |
| 400 | Bad Request | - |
| 401 | Access denied | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
| 409 | Conflict | - |
createAuthApiApplicationUsingPOST
AuthApiApplication createAuthApiApplicationUsingPOST(authApiApplicationParms)
Create Auth API application
Create an auth API application. Caller requires the APPLICATIONS:ADD permission.
Example
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| authApiApplicationParms | AuthApiApplicationParms |
Return type
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful | - |
| 400 | Bad Request | - |
| 401 | Access denied | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
| 409 | Conflict | - |
getAdminApiApplicationUsingGET
AdminApiApplication getAdminApiApplicationUsingGET(id)
Get Admin API application
Get an Admin API application. Caller requires the APPLICATIONS:VIEW permission.
Example
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | String | The UUID of the application to be fetched. |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful | - |
| 400 | Bad Request | - |
| 401 | Access denied | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
| 409 | Conflict | - |
getAuthApiApplicationUsingGET
AuthApiApplication getAuthApiApplicationUsingGET(id)
Get Auth API application
Get the specified auth API application. Caller requires the APPLICATIONS:VIEW permission.
Example
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | String | The UUID of the application to be fetched. |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful | - |
| 400 | Bad Request | - |
| 401 | Access denied | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
| 409 | Conflict | - |
listAdminApiApplicationsUsingGET
List<AdminApiApplication> listAdminApiApplicationsUsingGET()
List Admin API application
List Admin API application. Caller requires the APPLICATIONS:VIEW permission.
Example
Parameters
This endpoint does not need any parameter.
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful | - |
| 400 | Bad Request | - |
| 401 | Access denied | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
| 409 | Conflict | - |
listApplicationInfoUsingGET
List<ApplicationInfo> listApplicationInfoUsingGET()
List application information
List application information. Caller requires the APPLICATIONS:VIEW permission.
Example
Parameters
This endpoint does not need any parameter.
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful | - |
| 400 | Bad Request | - |
| 401 | Access denied | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
| 409 | Conflict | - |
listApplicationTemplatesUsingGET
List<ApplicationTemplate> listApplicationTemplatesUsingGET()
List application templates
List application templates. Caller requires the TEMPLATES:VIEW permission.
Example
Parameters
This endpoint does not need any parameter.
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful | - |
| 400 | Bad Request | - |
| 401 | Access denied | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
| 409 | Conflict | - |
listAuthApiApplicationsUsingGET
List<AuthApiApplication> listAuthApiApplicationsUsingGET()
List Auth API applications
List all auth API applications. Caller requires the APPLICATIONS:VIEW permission.
Example
Parameters
This endpoint does not need any parameter.
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful | - |
| 400 | Bad Request | - |
| 401 | Access denied | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
| 409 | Conflict | - |
removeAdminApiApplicationUsingDELETE
removeAdminApiApplicationUsingDELETE(id)
Remove Admin API application
Remove an Admin API application. Caller requires the APPLICATIONS:REMOVE permission.
Example
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | String | The UUID of the application to be removed. |
Return type
null (empty response body)
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful | - |
| 400 | Bad Request | - |
| 401 | Access denied | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
| 409 | Conflict | - |
removeAuthApiApplicationUsingDELETE
removeAuthApiApplicationUsingDELETE(id)
Remove Auth API application
Remove the specified auth API application. Caller requires the APPLICATIONS:REMOVE permission.
Example
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | String | The UUID of the application to be removed. |
Return type
null (empty response body)
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful | - |
| 400 | Bad Request | - |
| 401 | Access denied | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
| 409 | Conflict | - |
updateAdminApiApplicationUsingPUT
AdminApiApplication updateAdminApiApplicationUsingPUT(id, adminApiApplicationParms)
Update Admin API application
Update an Admin API application. Caller requires the APPLICATIONS:EDIT permission.
Example
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | String | The UUID of the application to be updated. | |
| adminApiApplicationParms | AdminApiApplicationParms |
Return type
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful | - |
| 400 | Bad Request | - |
| 401 | Access denied | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
| 409 | Conflict | - |
updateAdminApiSharedSecretUsingPUT
String updateAdminApiSharedSecretUsingPUT(id)
Regenerate Admin API application shared secret
Regenerate the shared secret for an Admin API application. Caller requires the APPLICATIONS:EDIT permission.
Example
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | String | The UUID of the application to be updated. |
Return type
String
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful | - |
| 400 | Bad Request | - |
| 401 | Access denied | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
| 409 | Conflict | - |
updateAuthApiApplicationUsingPUT
updateAuthApiApplicationUsingPUT(id, authApiApplicationParms)
Update Auth API application
Update the specified auth API application. Caller requires the APPLICATIONS:EDIT permission.
Example
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | String | The UUID of the application to be updated. | |
| authApiApplicationParms | AuthApiApplicationParms |
Return type
null (empty response body)
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful | - |
| 400 | Bad Request | - |
| 401 | Access denied | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
| 409 | Conflict | - |