vmware.vapi.vmc package

Submodules

vmware.vapi.vmc.client module

CSP Refresh token based SecurityContextFilter

vmware.vapi.vmc.client.PUBLIC_CSP_URL = 'https://console.cloud.vmware.com'
vmware.vapi.vmc.client.PUBLIC_VMC_URL = 'https://vmc.vmware.com/'
class vmware.vapi.vmc.client.VmcClient(session, refresh_token, vmc_url, csp_url)

Bases: vmware.vapi.bindings.stub.ApiClient

VMC Client class that providess access to stubs for all the services in the VMC API

Initialize VmcClient by creating a stub factory instance using a CSP Security context filter added to the filter chain of the connector

Parameters

  • session (requests.Session) – Requests HTTP session instance

  • refresh_token (str) – Refresh token obtained from CSP

  • vmc_url (str) – URL of the VMC service

  • csp_url (str) – URL of the CSP service

vmware.vapi.vmc.client.create_vmc_client(refresh_token, session=None)

Helper method to create an instance of the VMC API client using the public VMC and CSP URL.

Parameters

  • refresh_token (str) – Refresh token obtained from CSP

  • session (requests.Session or None) – Requests HTTP session instance. If not specified, then one is automatically created and used

Return type

vmware.vapi.vmc.client.VmcClient

Returns

VMC Client instance

vmware.vapi.vmc.csp_filter module

CSP Refresh token based SecurityContextFilter

class vmware.vapi.vmc.csp_filter.CSPSecurityContextFilter(session, refresh_token, refresh_url)

Bases: vmware.vapi.security.client.security_context_filter.SecurityContextFilter

CSP Security Context filter in API Provider chain adds the security context based on a refresh token to the execution context passed in.

Initialize SecurityContextFilter

Parameters

  • session (requests.Session) – Requests Session object to use for making HTTP calls

  • refresh_token (str) – Refresh token to use for obtaining an access token

  • refresh_url (str) – URL that allows exchanging a refresh token for an access token

get_max_retries()

Get the max number of retries

Return type

int

Returns

Number of retries

get_security_context(on_error)

Retrieve security context. If this method is called after an error occured, then a new access token is obtained using the refresh token and a new security context is created.

Parameters

on_error (bool) – Whether this method is called after getting an error

Return type

vmware.vapi.core.SecurityContext

Returns

Security context

should_retry(error_value)

Returns whether the request should be retried or not based on the error specified.

Parameters

error_value (vmware.vapi.data.value.ErrorValue) – Method error

Return type

bool

Returns

Returns True if request should be retried in case the error is either Unauthenticated or Unauthorized else False