This API has a deprecated equivalent from v7.0U1.
Create Session
Creates a session with the API. This is the equivalent of login. This operation exchanges user credentials supplied in the security context for a session token that is to be used for authenticating subsequent calls. To authenticate subsequent calls clients are expected to include the session token. For REST API calls the HTTP vmware-api-session-id header field should be used for this.
Request
URLURL
https://{api_host}/api/session
Header Parameters
Header Parameters
string
Authorization
Required
Required basic authentication header. Takes in a Base64 encoded value of your username:password
Authorization example
"Basic dXNlcm5hbWU6cGFzc3dvcmQ="
Authentication
This operation uses the following authentication methods.
Response
Response
Response BodyResponse Body
201 Created returns
string
formatted as password
of type application/json
Newly created session token to be used for authenticating further requests.
Errors
401
com.vmware.vapi.std.errors.unauthenticated : if the session creation fails due to request specific issues. Due to the security nature of the API the details of the error are not disclosed. Please check the following preconditions if using a SAML token to authenticate:
- the supplied token is delegate-able.
- the time of client and server system are synchronized.
- the token supplied is valid.
- if bearer tokens are used check that system configuration allows the API endpoint to accept such tokens.
503
com.vmware.vapi.std.errors.service_unavailable : if session creation fails due to server specific issues, for example connection to a back end component is failing. Due to the security nature of this API further details will not be disclosed in the error. Please refer to component health information, administrative logs and product specific documentation for possible causes.
default
‘Default’ means this response is used for all HTTP codes that are not covered individually for this operation.
Code Samples
PowerCLI Client SDK Example
$Server = 'VC IP/FQDN'
$User = 'VC user'
$Password = 'VC password' | ConvertTo-SecureString -AsPlainText -Force
# Create vSphere Server Configuration with the provided Credentials.
$serverConfiguration = New-vSphereServerConfiguration -Server $Server -User $User -Password $Password
# Creates a Session with the vSphere API.
$apiSession = Invoke-CreateSession -WithHttpInfo
# Set the API Key in the vSphere Server Configuration, received with the API Session.
$serverConfiguration = $serverConfiguration | Set-vSphereServerConfigurationApiKey -SessionResponse $apiSession
cURL Command
curl -X POST -H "Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=" https://{api_host}/api/session
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-deprecated-method: post
x-vmw-doc-deprecated-path: /rest/com/vmware/cis/session
x-vmw-doc-operation: create
Availability
Added in 7.0U2
