LDAP users and local users are defined by the vCloud Director integrated identity provider, and must include credentials in the form required by Basic HTTP authentication when making a the request to create a vCloud API Session.
■
|
Verify that you know the API login URL. See Example: Retrieve the Login URL and List of Supported API Versions. |
■
|
Verify that you are logging in as a user whose identity is managed by the vCloud Director integrated identity provider. |
1 | Use the login URL to authenticate to the vCloud API. POST a request to this URL. The request must include your username, organization name, and password in a MIME Base64 encoding. See Example: Create a Login Session Using the Integrated Identity Provider. |
2 |
The response code indicates whether the request succeeded, or how it failed. |
A valid request returns a Session element. See Example: Create a Login Session Using the Integrated Identity Provider.
A request to create a login session using the Integrated Identity provider must supply the user's credentials in the following form:
user@organization:password
■
| |
■
| |
■
|
These credentials must be supplied in a MIME Base64 encoding, as specified in RFC 1421.
This example shows a Basic HTTP authentication login request and response for a user logging in to the Finance organization of a cloud whose API login URL is https://vcloud.example.com/api/sessions.
POST https://vcloud.example.com/api/sessions Authorization: Basic encoded-credentials Accept: application/*;version=9.0
200 OK ... <Session xmlns="http://www.vmware.com/vcloud/v1.5" userUrn="urn:vcloud:user:fe50b0b5-..." user="bob" org="Finance" ... > <Link rel="down" type="application/vnd.vmware.vcloud.org+xml" name="System" href="https://vcloud.example.com/api/org/5" /> <Link rel="down" type="application/vnd.vmware.vcloud.query.queryList+xml" href="https://vcloud.example.com/api/query" /> <Link rel="entityResolver" type="application/vnd.vmware.vcloud.entity+xml" href="https://vcloud.example.com/api/entity/" /> <Link rel="down:extensibility" type="application/vnd.vmware.vcloud.apiextensibility+xml" href="https://vcloud.example.com/api/extensibility" /> </Session>
The response includes several Link types, including:
A link to your organization. See Retrieve a List of Organizations Accessible to You. | |
A link to the set of typed queries the user can run. See Using the Query Service. | |
A link to the entity resolver. See Retrieve an Object as an Entity. | |
A link to the extensibility framework entry point. See vCloud Director Extension Services. |