External applications REST API

Get all external applications

Table 1. Get all external applications
REST API information	Value	Description
URI	/admin/resources/external_applications
Method	GET
Returns	200	Returns a list of all external applications.
	404	No external applications were found.
	500	The system encountered an internal error while processing the request.

Returns a list of external applications.

Attributes list

id

The unique ID of the object in the system.

created_time

The time at which the object is created.

external_users

List of external users that are created for this external application.

full_datacenter_access

T or F. Indicates whether access is provided all virtual manager resources or not. Default is F.

host_access

T or F. Indicates whether compute node users are created. Default is F.

name

Used to identify this resource; must be unique.

privilege_set

Set of privileges that are granted on Virtual Manager resources. default allows typical deployment operations while readonly is a more limited set for monitoring purposes. Defaults to default.

state

Possible values are:

pending: The external application is being created or passwords for the associated external users are being regenerated

available: The external application is ready for use.

deleting: The external application is being deleted.

storage_access

T or F. Indicates whether a storage controller user is created. Default is F. Set this attribute to T if you are creating an external application for storage monitoring.

updated_time

The time at which the record was last updated.

vdcs

List of associated cloud groups (used when full_datacenter_access = F)

Get a specific external application

Table 2. Get a specific external application
REST API information	Value	Description
URI	/admin/resources/external_applications/`{id}`
Method	GET
Returns	200	Returns an external application.
	404	The external application was not found.
	500	The system encountered an internal error while processing the request.

Returns a specific external application.

Create an external application

Table 3. Create an external application
REST API information	Value	Description
URI	/admin/resources/external_applications
Method	POST
Returns	202	External application was created successfully.
	401	The user is not authorized to create an external application.
	500	The system encountered an internal error while processing the request.

Creates an external application. Name is the only required field and must be unique. Example JSON:


{ "name": "ExternalApp1",

  "vdcs": ["a78bd4ab-2304-4e18-97fd-7c5ac9575add"],
  "host_access": "T"}

Regenerate passwords for associated external users

Table 4. Regenerate passwords for associated external users
REST API information	Value	Description
URI	/admin/resources/external_applications/`{id}`?regeneratePasswords=true
Method	PUT
Returns	202	External application was created successfully.
	401	The user is not authorized to create an external application.
	500	The system encountered an internal error while processing the request.

Regenerates passwords for external users that are associated with the specified external application. The JSON content can be empty. If it is not empty, any changes to the fields of the resource are ignored because modifying an external application is not supported.

Delete an external application

Table 5. Delete an external application
REST API information	Value	Description
URI	/admin/resources/external_applications/`{id}`
Method	DELETE
Returns	202	External application was deleted successfully.
	404	The external application was not found.
	500	The system encountered an internal error while processing the request.

Deletes an external application.