VCF Automation OpenAPI Operations Index

VCF Automation OpenAPI Operations Index

All available VCF Automation OpenAPI Operations

Audit Trail
GET
Query Audit Trail

Get list of audit trail events

Branding Theme
GET
Get Active Theme Main Flavor

Get a description of a theme to be applied. The response contains relative URLs to each file comprising the theme in its main flavor. To fetch each file, build a URL from filesRoot + files[i] and GET it. This resource is accessible without authentication.

GET
Get Active Theme

Get a description of a theme to be applied. The response contains relative URLs to each file comprising the theme in the requested flavor. All mandatory resources are included, even if the theme does not explicitly define such flavor(in which case the main flavor is used). To fetch each file, build a URL from filesRoot + files[i] and GET it. This resource is accessible without authentication.

GET
Get Theme File

Load a file of a theme with the given id, if it exists. This resource is accessible without authentication and without the need to specify Accept header containing an api version.

GET
Get Theme Flavor File

Load a file of a theme with the given id, if it exists. This resource is accessible without authentication and without the need to specify Accept header containing an api version.

Certificate Library
GET
Query Certificate Library

Get a list of the certificate library items

POST
Add Certificate Library Item

Add an item to the certificate library

GET
Get Certificate Library Item

Retrieves the specified certificate library item. Note: This API also supports a former (erroneously spelt) alternate path /cetificateLibrary/{id} as a Deprecated API (deprecated-in and removed after API version 36.0)

PUT
Update Certificate Library Item

Updates the specified certificate library item. Only the alias and description fields may be edited Note: This API also supports a former (erroneously spelt) alternate path /cetificateLibrary/{id} as a Deprecated API (deprecated-in and removed after API version 36.0)

DELETE
Delete Certificate Library Item

Delete the specified certificate library item. Only items that are not in use can be deleted. Note: This API also supports a former (erroneously spelt) alternate path /cetificateLibrary/{id} as a Deprecated API (deprecated-in and removed after API version 36.0)

GET
Query Cert Library Item Consumer Refs

Get list of consumers (as references) of a particular certificate library item

POST
Add Consumer Ref To Cert Library Item

Adds the specified consumer reference to a library item.

PUT
Replace Cert Library Item Consumer Refs

Replaces the existing consumer refs with the consumer references supplied.

Device Authorization
POST
Find Device Authorization Request

Looks up a service account identified by the specified user code for processing its authorization request

POST
Grant Device Authorization

Grants access to service account identified by the specified user code. Subsequent polling by the device will result in access token to be transmitted as per device code flow specification

POST
Deny Device Authorization

A device's request for access on behalf of a service account, as identified by the specified user code, is denied

Entity
GET
Resolve Entity

Get specified entity object

Group
GET
Query Groups

Get a list of groups.

POST
Create Group

Create a new group.

GET
Get Group

Get a specified group.

PUT
Update Group

Modify details of the specified group.

DELETE
Delete Group

Delete the specified group.

GET
Query Group Users

Get a list of users of any type that belong to the specified group.

Ldap
POST
Test Ldap

Tests that custom LDAP settings are valid, and that the system can use them to search for a user or group

POST
Sync Ldap

Begins the LDAP sync task

GET
Search Ldap Users

Searches LDAP for given user(s)

GET
Search Ldap Groups

Searches LDAP for given group(s)

Notification Settings
GET
Get Notification Settings

Get configured notification settings.

PUT
Update Notification Settings

Updates notification settings.

Org
GET
Query Orgs

Get list of all orgs accessible to the user.

GET
Get Org

Get specified organization.

PUT
Update Org

Updates an organization. If the managedBy field is being updated, the operation is asynchronous and a task is returned in the location header. Otherwise, the operation is synchronous.

Organization Settings
GET
Get Org Settings

Get all organization settings accessible to the user.

PUT
Update Org Settings

Updates the organization settings accessible to the user.

Preferences
GET
Query Preferences Vcf

Query user preferences for the logged in user with sorting, paging, and filtering support.

GET
Get Preference

Get specified user preference.

PUT
Update Preference

Update specified user preference

GET
Query User Preferences

Query user preferences for a specific user

GET
Get User Preference

Get a preference for a specific user.

PUT
Update User Preference

Update a preference for a specific user.

Rights
GET
Query Rights

Get list of rights

GET
Get Right

Retrieves the requested Right by id.

Rights Categories
GET
Query Rights Categories

Get list of Rights Categories

GET
Get Rights Category

Retrieves the requested Rights Category by id.

Roles
GET
Query Tenant Roles

Get list of roles for a tenant

GET
Get Role

Get specified role

GET
Query Role Rights

Get list of rights (as references) contained by a particular role

Service Account
GET
Query Service Accounts

Get a list of all service accounts.

GET
Get Service Account

Retrieves a specific service account

PUT
Update Service Account

Updates a service account

DELETE
Delete Service Account

Deletes a service account

POST
Revoke Service Account

Revokes the token associated with given service account URN, invalidates any existing sessions.

POST
Take Ownership

Transfer ownership of this user's owned entities (vApps, media, etc) to the caller.

Sessions
GET
Get Current Sessions

List all sessions for current user

POST
Login

Logs in a user

GET
Get Session

Returns the specified session for current user

DELETE
Logout

Logs out the current user

GET
Get Current Session

Returns the specified session for the authorization token

DELETE
Logout Current Session

Logs out and terminates the current session identified by credentials supplied using the Authorization header

GET
Get Current Session Rights

Returns the rights associated with the current session.

Test Connection
POST
Test

Tests a connection, including SSL handshake and hostname verification.

Token
GET
Get Tokens

Retrieve tokens

GET
Get Token

Retrieves a specific token

PUT
Update Token

Update a token

DELETE
Delete Token

Delete a specific token. Use this to revoke the current token in case of a leak.

Trusted Certificates
GET
Query Trusted Certificates

Get currently trusted certificates

POST
Trust Certificate

Add to list of currently trusted certificates

GET
Get Certificate

Get the PEM-encoded certificate with the requested URN

PUT
Update Certificate

Updates an existing trusted certificate

DELETE
Delete Certificate

Revoke trusting specified certificate

User
GET
Query Users

Get a list of users.

POST
Create User

Create a new user.

GET
Get User

Get a specified user by id.

PUT
Update User

Modify basic details of the specified user.

DELETE
Delete User

Delete the specified user.

GET
Query User Groups

Get a list of references of groups that the user with the given id belongs to.

PUT
Modify User Groups

Adds a list of group references that the user with the given id belongs to. This endpoint allows for the group membership info to be pre-populated before a user logs in for the first time.

POST
Change Password

Modify an existing user's own password

POST
Take Ownership

Transfer ownership of this user's owned entities (vApps, media, etc) to the caller.