vCenter Single Sign On SDK Readme

 VMware logo

JAXWS Java Samples Readme   Readme for Java Samples
vSphere Management SDK Readme   Readme for the vSphere Management SDK

Welcome to the vCenter Single Sign On SDK. This Readme contains these topics:
Note:   Information in this document may not be current. For up-to-date information, check these VMware Web sites:
Beta or Pre-release Products VMware Beta Community
Released SDK ProductsVMware vSphere Web Services SDK

What is the vCenter Single Sign On API?

A vCenter Single Sign On client uses the vCenter Single Sign On API to connect to the vCenter Single Sign On Server for the purpose of obtaining a security token. The token contains authentication claims required for operations in the vSphere environment. The vCenter Single Sign On API supports operations to acquire, renew, and validate tokens.

For information about how to use the vCenter Single Sign On API, see the vCenter Single Sign On Programming Guide. For access to the guide, use the link to the vSphere Document Center on the vSphere Web Services SDK Documentation page.

What’s in the SDK Package?

The vCenter Single Sign On SDK provides:

  • Sample code that demonstrates the following tasks:

    • How to use the vCenter Single Sign On API to retrieve a SAML token.
    • How to use the LoginByToken method to establish a single sign on session.

    The sample code includes Java and C# examples of how to use the vCenter Single Sign On API:

    • Visual Studio projects. See the readme file for the C# samples (SDK/ssoclient/dotnet/cs/samples/README.txt).
    • Compiled and ready-to-run Java class files, as well as Java source code files. See the readme file for the java samples (readme_java) for information about building and using the samples.

  • Web Services Definition Language (WSDL) definitions that describe the API for accessing the vCenter Single Sign On Server. The SDK contains the STSService.wsdl file and the supporting schema files.

  • Shell scripts to run the sample applications.

  • Compiled client-side libraries (ssoclient.jar, vim25.jar, samples.jar) for testing and development purposes.

The vCenter Single Sign On SDK is contained in the SDK\ssoclient directory in the vSphere Management SDK.

    VMware-vSphere-SDK-x.y.z-build
      SDK
        ssoclient

The following table contains a brief description of the contents of the vCenter Single Sign On Client SDK.

Directory structure (under \SDK\ssoclient):

DirectoryContentsDocumentation
docs Root directory for Java sample documentation. JAXWS samples documentation
dotnet\cs Root directory for the C# files. Contains the Visual Studio solution file (SSOSample.sln),.bat files, and the samples directory which contains the Visual Studio projects. SDK/ssoclient/dotnet/cs/sample/README.txt
java\JAXWS Root directory for the JAXWS files. Contains batch files, .jar files, and samples. Readme for Java samples
wsdl WSDL files for the vCenter Single Sign On API:
  • STSService.wsdl - Contains the vCenter Single Sign On API definitions.
  • Schema files that support the vCenter Single Sign On API definitions.
  

VMware Resources

For released product information, including known issues, see the VMware Infrastructure SDK page. Be sure to read the Release Notes for the most recent information.

Copyright © 2012-2016 VMware, Inc. All rights not expressly granted herein are reserved.

Last updated: 15 Nov 2016 |  vCenter Single Sign On Client SDK