REST API - create
  1. Operations
  2. cis
  3. session

cis session: create

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 identifier that is to be used for authenticating subsequent calls. To authenticate subsequent calls clients are expected to include the session key.

Request:

HTTP request

POST https://{server}/rest/com/vmware/cis/session
No request parameters

Response:

HTTP Status Code: 200

Representation:

{
    "value" : "secret string"
}

Response Type:

Name Type Description
bold = required
value secret Newly created session identifier to be used for authenticating further requests.

Errors:

HTTP Status Code Type Description
401 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 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.