vmware_sso_client_prog_guide_1_0

vCenterSingleSignOnProgrammingGuidevCenterSingleSignOnSDKvSphere5.1Thisdocumentsupportstheversionofeachproductlistedandsupportsallsubsequentversionsuntilthedocumentisreplacedbyanewedition.Tocheckformorerecenteditionsofthisdocument,see::[e-mail] Copyright©2012VMware,Inc.Allrightsreserved.ThisproductisprotectedbyU.S.andinternationalcopyrightandintellectualpropertylaws.VMwareproductsarecoveredbyoneormorepatentslistedat This Book3Single Sign‐On in the vSphere Environment5vCenter Single Sign On Overview5vCenter Single Sign On Client API7Acquiring a SAML Token7vCenter Single Sign On Security Policies8Connecting to a vCenter Single Sign On Server9Token Delegation10Token Lifetime ‐ Clock Tolerance10Challenge (SSPI)10vCenter Single Sign On SOAP Message Structure11vCenter Single Sign On SDK11vCenter Single Sign On SDK Examples12vCenter Single Sign OnAPI Reference13vCenter Single Sign On Client API Methods13Issue13Renew14Validate14Challenge15vCenter Single Sign On API Data Structures15RequestSecurityTokenType15RequestSecurityTokenResponseCollectionType17RequestSecurityTokenResponseType17LifetimeType18RenewingType18KeyTypeOpenEnum18UseKeyType19ParticipantsType19ParticipantType19EndpointReference19BinaryExchangeType19AdviceType20AttributeType20vCenter Single Sign OnClient Example (JAX‐WS)21vCenter Single Sign On Token Request Overview21Using Handler Methods for SOAP Headers22Sending a Request for a Security Token24LoginByToken Example (JAX‐WS)27vCenter Server Single Sign On Session27HTTP and SOAP Header Handlers27Sample Code28Saving the vCenter Server Session Cookie29vCenterSingleSign-OnProgrammingGuide2VMware,Inc.Using LoginByToken30Restoring the vCenter Server Session Cookie31Index33VMware,Inc.3vCenter Single Sign‐On Programming Guide describes how to use the VMware® vCenter Single Sign On API. VMware provides different APIs and SDKs for different applications and goals. The vCenter Single Sign On SDK supports the development of vCenter clients that use SAML token authentication for access to vSphere environments.To view the current version of this book as well as all VMware API and SDK documentation, go to  book is revised with each release of the product or when necessary. A revised version can contain minor or major changes. Table1 summarizes the significant changes in each version of this book.IntendedAudienceThis book is intended for anyone who needs to develop applications using the vCenter Single Sign On SDK. Developers typically create vCenter Single Sign On client applications using Java to access the vCenter Single Sign On Server. An understanding of Web Services technology and some programming background in one of the stub languages (Java) is required..VMwareTechnicalPublicationsGlossaryVMware Technical Publications provides a glossary of terms that might be unfamiliar to you. For definitions of terms as they are used in VMware technical documentation go to  welcomes your suggestions for improving our documentation. Send your feedback to [e-mail]ateDescription08Nov2012vCenter Single Sign On SDK V1.0 documentation update – changed SOAP envelope description to identify SSL/TLS (Transport Layer Security) correctly.10Sep2012vCenter Single Sign On SDK V1.0 documentation.vCenterSingleSign-OnProgrammingGuide4VMware,Inc.VMware,Inc.51A vCenter Single Sign‐On client connects to the vCenter Single Sign On Server to obtain a security token that contains authentication claims required for operations in the vSphere environment. The vCenter Single Sign On client API supports operations to acquire, renew, and validate tokens.This chapter includes the following topics: vCenter Single Sign On OverviewvCenter Single Sign On Client APIAcquiring a SAML TokenvCenter Single Sign On SOAP Message StructurevCenter Single Sign On SDKvCenterSingleSignOnOverviewTo support the requirements for secure software environments, software components require authorization to perform operations on behalf of a user. In a single sign‐on environment, a user provides credentials once, and components in the environment perform operations based on the original authentication. vCenter Single Sign On authentication can use the following identity store technologies:Windows