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

Create Admin API application

Create an Admin API application. Caller requires the APPLICATIONS:ADD permission.

Using the CreateAdminApiApplicationUsingPOSTWithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

Parameters

Name	Type	Description	Notes
adminApiApplicationParms	AdminApiApplicationParms

Return type

AdminApiApplication

Authorization

AdminAPIAuthentication

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

Create Auth API application

Create an auth API application. Caller requires the APPLICATIONS:ADD permission.

Example

Using the CreateAuthApiApplicationUsingPOSTWithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

Parameters

Name	Type	Description	Notes
authApiApplicationParms	AuthApiApplicationParms

Return type

AuthApiApplication

Authorization

AdminAPIAuthentication

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 (string id)

Get Admin API application

Get an Admin API application. Caller requires the APPLICATIONS:VIEW permission.

Example

Using the GetAdminApiApplicationUsingGETWithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

Parameters

Name	Type	Description	Notes
id	string	The UUID of the application to be fetched.

Return type

AdminApiApplication

Authorization

AdminAPIAuthentication

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 (string id)

Get Auth API application

Get the specified auth API application. Caller requires the APPLICATIONS:VIEW permission.

Example

Using the GetAuthApiApplicationUsingGETWithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

Parameters

Name	Type	Description	Notes
id	string	The UUID of the application to be fetched.

Return type

AuthApiApplication

Authorization

AdminAPIAuthentication

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

Using the ListAdminApiApplicationsUsingGETWithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

Parameters

This endpoint does not need any parameter.

Return type

List<AdminApiApplication>

Authorization

AdminAPIAuthentication

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

Using the ListApplicationInfoUsingGETWithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

Parameters

This endpoint does not need any parameter.

Return type

List<ApplicationInfo>

Authorization

AdminAPIAuthentication

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

Using the ListApplicationTemplatesUsingGETWithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

Parameters

This endpoint does not need any parameter.

Return type

List<ApplicationTemplate>

Authorization

AdminAPIAuthentication

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

Using the ListAuthApiApplicationsUsingGETWithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

Parameters

This endpoint does not need any parameter.

Return type

List<AuthApiApplication>

Authorization

AdminAPIAuthentication

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

void RemoveAdminApiApplicationUsingDELETE (string id)

Remove Admin API application

Remove an Admin API application. Caller requires the APPLICATIONS:REMOVE permission.

Example

Using the RemoveAdminApiApplicationUsingDELETEWithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

Parameters

Name	Type	Description	Notes
id	string	The UUID of the application to be removed.

Return type

void (empty response body)

Authorization

AdminAPIAuthentication

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

void RemoveAuthApiApplicationUsingDELETE (string id)

Remove Auth API application

Remove the specified auth API application. Caller requires the APPLICATIONS:REMOVE permission.

Example

Using the RemoveAuthApiApplicationUsingDELETEWithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

Parameters

Name	Type	Description	Notes
id	string	The UUID of the application to be removed.

Return type

void (empty response body)

Authorization

AdminAPIAuthentication

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 (string id, AdminApiApplicationParms adminApiApplicationParms)

Update Admin API application

Update an Admin API application. Caller requires the APPLICATIONS:EDIT permission.

Example

Using the UpdateAdminApiApplicationUsingPUTWithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

Parameters

Name	Type	Description	Notes
id	string	The UUID of the application to be updated.
adminApiApplicationParms	AdminApiApplicationParms

Return type

AdminApiApplication

Authorization

AdminAPIAuthentication

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 (string id)

Regenerate Admin API application shared secret

Regenerate the shared secret for an Admin API application. Caller requires the APPLICATIONS:EDIT permission.

Example

Using the UpdateAdminApiSharedSecretUsingPUTWithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

Parameters

Name	Type	Description	Notes
id	string	The UUID of the application to be updated.

Return type

string

Authorization

AdminAPIAuthentication

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

void UpdateAuthApiApplicationUsingPUT (string id, AuthApiApplicationParms authApiApplicationParms)

Update Auth API application

Update the specified auth API application. Caller requires the APPLICATIONS:EDIT permission.

Example

Using the UpdateAuthApiApplicationUsingPUTWithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

Parameters

Name	Type	Description	Notes
id	string	The UUID of the application to be updated.
authApiApplicationParms	AuthApiApplicationParms

Return type

void (empty response body)

Authorization

AdminAPIAuthentication

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	-