| auth_code |
Auth Code
Client's credentials. |
Oauth2Credentials |
|
| base_url |
CSP base URL
Protocol and domain name (or IP address) of a CSP server, like "https://console-stg.cloud.vmware.com". |
string |
|
| basic_auth_whitelist_ips |
Whitelist IPs
List of whitelist IPs for basic auth |
array of string |
|
| csp_access_token_uri |
CSP endpoint that exchanges a grant for an access token
This CSP end-point exchanges one of the following grants - authorization_code, refresh_token, client_credentials or client_delegate for an access token. |
string |
|
| csp_client_credential |
CSP Client Credential
Client's credentials on CSP server |
Oauth2Credentials |
|
| csp_client_incoming_credentials |
CSP client incoming credentials
List of incoming client IDs |
array of string |
|
| csp_logout_uri |
CSP endpoint that returns the identity provider's logout url
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 |
Relative path to CSP Org
Relative path on CSP server to the Org location. Can be "/csp/gateway/am/api/orgs/". |
string |
|
| csp_public_key_uri |
CSP endpoint to get the list of public keys in JWKS format
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. |
string |
|
| csp_time_drift |
CSP time drift
CSP time drift in milliseconds |
integer |
|
| csp_user_authorization_uri |
CSP Discovery login entry point for OAuth 2.0 authorization
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 |
CSP user info endpoint
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 |
Org ID of a Client
Org ID of a Client - commonly UUID. |
string |
|
| ea_org |
Org Info for "Site Reliability Engineer"
Org ID and role of "Site Reliability Engineer" |
OrgInfo |
|
| gss_org |
Org Info for "Global Support Services"
Org ID and role of "Global Support Services" |
OrgInfo |
|
| mode_change_only |
Only change node mode
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. |
boolean |
|
| mode_id |
Nsx node mode
Possible enum values in a "/config/nsx_appliance_mode" file |
string |
Required
Enum: ON_PREM, SERVICE, VMC, VMC_LOCAL |
| proxy_host |
IP/host of PoP (Point-of-Presence) HTTP proxy server |
HostnameOrIPAddress |
|
| proxy_port |
Port of PoP (Point-of-Presence) Http proxy server |
integer |
Minimum: 1
Maximum: 65535 |
| public_client_info |
OAuth2 info for public clients
OAuth2 info for public clients |
PublicClientInfo |
|
| resource_type |
Node Mode type |
string |
Enum: SwitchingToVmcModeParameters
Default: "SwitchingToVmcModeParameters" |
| sddc_id |
SDDC id
SDDC id |
string |
|
| service_definition_id |
Service definition id
Service definition id |
string |
|
| sre_org |
Org Info for "Enterprise Admin"
Org ID and role of "Enterprise Admin" |
OrgInfo |
|