InlineSwitchingToVmcModeParameters1

InlineSwitchingToVmcModeParameters1
InlineSwitchingToVmcModeParameters1
JSON Example
{
    "auth_code": {
        "client_id": "string",
        "client_secret": "string"
    },
    "base_url": "string",
    "basic_auth_whitelist_ips": [
        "string"
    ],
    "csp_access_token_uri": "string",
    "csp_client_credential": "Oauth2Credentials Object",
    "csp_client_incoming_credentials": [
        "string"
    ],
    "csp_logout_uri": "string",
    "csp_org_uri": "string",
    "csp_public_key_uri": "string",
    "csp_time_drift": 0,
    "csp_user_authorization_uri": "string",
    "csp_user_info_uri": "string",
    "default_org_id": "string",
    "ea_org": "OrgInfo Object",
    "gss_org": "OrgInfo Object",
    "mode_change_only": false,
    "proxy_host": "string",
    "proxy_port": 0,
    "public_client_info": "PublicClientInfo Object",
    "resource_type": "string",
    "saas_csp_client_credential": "Oauth2Credentials Object",
    "saas_service_url": "string",
    "sddc_id": "string",
    "service_definition_id": "string",
    "sre_org": "OrgInfo Object"
}
Oauth2Credentials
auth_code
Optional

Oauth2 Account Credentials

string
base_url
Optional

Protocol and domain name (or IP address) of a CSP server, like "https://console-stg.cloud.vmware.com".

array of string
basic_auth_whitelist_ips
Optional

List of whitelist IPs for basic auth

string
csp_access_token_uri
Optional

This CSP end-point exchanges one of the following grants - authorization_code, refresh_token, client_credentials or client_delegate for an access token.

Oauth2Credentials
csp_client_credential
Optional

Oauth2 Account Credentials

array of string
csp_client_incoming_credentials
Optional

List of incoming client IDs

string
csp_logout_uri
Optional

This CSP end-point returns the identity provider's logout url. In order to logout, an explicit redirect to this url is needed.

string
csp_org_uri
Optional

Relative path on CSP server to the Org location. Can be "/csp/gateway/am/api/orgs/".

string
csp_public_key_uri
Optional

CSP endpoint that returns a list of public keys in jwks format. These keys are used in an application to validate that the access-token is valid.

integer As int64 As int64
csp_time_drift
Optional

CSP time drift in milliseconds

string
csp_user_authorization_uri
Optional

This endpoint is used with browser redirection only. It discovers the user's Identity Provider (IdP) and sends the user to the IdP login page. It is the starting point of the OAuth 2.0 flow to authenticate end users from an application.

string
csp_user_info_uri
Optional

This endpoint returns the content of the given access token if the token is valid. It also includes the group_ids and group_names if the client is registered with group_id, group_names scopes. It's usually /am/api/userinfo.

string
default_org_id
Optional

Org ID of a Client - commonly UUID.

OrgInfo
ea_org
Optional

Organization ID and role, predefined for a particular type of VMware support.

OrgInfo
gss_org
Optional

Organization ID and role, predefined for a particular type of VMware support.

boolean
mode_change_only
Optional

When this parameter is set to true, only a change of the node mode happens without any update to the auth properties. When this param is not set to true i.e. set to false or not provided, mode change and update to the auth properties will both happen.

string As hostname-or-ip As hostname-or-ip
proxy_host
Optional

IP/host of PoP (Point-of-Presence) HTTP proxy server

integer As int64 As int64
proxy_port
Optional
Constraints: minimum: 1 maximum: 65535

Port of PoP (Point-of-Presence) Http proxy server

PublicClientInfo
public_client_info
Optional

Parameters needed to specify a PKCE OAuth2 client.

string
resource_type
Optional
Constraints: default: SwitchingToVmcModeParameters

Node Mode type

Oauth2Credentials
saas_csp_client_credential
Optional

Oauth2 Account Credentials

string
saas_service_url
Optional

Protocol and domain name (or IP address) of a SAAS server, like "https://stg.skyscraper.vmware.com".

string
sddc_id
Optional

SDDC id

string
service_definition_id
Optional

Service definition id

OrgInfo
sre_org
Optional

Organization ID and role, predefined for a particular type of VMware support.

Used By