[{"label":"Latest (1.0)","version":"latest"}]
srs-for-vsphere

Login

Description

Uses vCenter Server SSO as Identity and Authentication Server. Two types of authentication are supported SIGN and Basic. When Basic authentication is used, the service exchanges username and password for SAML Token from the vCenter Server SSO. When SIGN authentication is used, the service exchanges the SSO SAML token from the SIGN token for another SAML token on behalf of the principal from the vCenter Server SSO. On successful authentication with the SSO, the service returns X-SRS-API-KEY token in the response headers. X-SRS-API-KEY token authorizes access to the service resources.The service associates X-SRS-API-KEY token to the acquired SSO SAML token. The associated SSO SAML token authenticates PowerCLI to the vCenter services.

Request

Request

URL

URL


post
https://{api_host}/api/auth/login
Copy

Authentication

Authentication

This operation uses the following authentication methods.
METHOD

basicAuth


METHOD

signAuth


Response

Response

200 OK

Success

Errors

Errors

401

Unauthorized


500

Server Error

Code Samples

Code Samples

cURL Command

curl -X POST https://{api_host}/api/auth/login
Vendor Extensions

Vendor Extensions

This operation contains the following vendor extensions defined in the spec:
x-vmw-vapi-methodname: login
x-vmw-vapi-servicename: authentication


[{"label":"Latest (1.0)","version":"latest"}]
srs-for-vsphere
Authentication Operations
Feedback

Was this page helpful?