POST licenseSession

Obtains authorization for a feature requested by an user, establishing a session between the licensed application and Cloud Connect.

Only an authorized customer can access features of the licensed application. This request is used to authorize the user's access to a feature. Once an authorization is obtained, this request establishes a session between the licensed application and the Cloud Connect.

For information on which license to retrieve if the same feature exists in multiple entitlements of a customer, refer to the section Priority Logic for Feature Consumption.

Type

POST

URI

<SCC_URL>/licenseSessions

The <SCC_URL> represents the Cloud Connect URL sent by Directory Service (also called, YPS) in response to the POST registration request.

Example URI

https://fra01-he02.trial.sentinelcloud.com/scc/licenseSessions

URI Parameter

None

Request Body

<?xml version="1.0" encoding="UTF-8"?>
<licenseSession>
	<user>u1</user>
	<customer>cloud</customer>
	<featureNode>
		<featureVersion>1.0</featureVersion>
		<featureName>cloud</featureName>
	</featureNode>
	<vendorData>Runtime-1234-1</vendorData>
	<unitsRequired>2</unitsRequired>
	<usageCountMultiplier>36</usageCountMultiplier>
</licenseSession>

Elements in the Request XML

usage count consumed = usageCountMultiplier at the start + usageCountMultiplier at the update

Request Schema

<?xml version="1.0"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema">
	<xs:element name="licenseSession">
		<xs:complexType>
			<xs:sequence>
				<xs:element type="xs:string" name="user" minOccurs='1' maxOccurs='1'/>
				<xs:element type="xs:string" name="customer" minOccurs='1' maxOccurs='1'/>
				<xs:element name="featureNode">
					<xs:complexType>
						<xs:sequence>
							<xs:element type="xs:string" name="featureVersion" minOccurs='0' maxOccurs='1'/>
							<xs:element type="xs:string" name="featureName" minOccurs='1' maxOccurs='1'/>
						</xs:sequence>
					</xs:complexType>
				</xs:element>
				<xs:element type="xs:string" name="vendorData" minOccurs='0' maxOccurs='1'/>
				<xs:element type="xs:int" name="unitsRequired" minOccurs='0' maxOccurs='1'/>
				<xs:element type="xs:int" name="usageCountMultiplier" minOccurs='0' maxOccurs='1'/>
			</xs:sequence>
		</xs:complexType>
	</xs:element>
</xs:schema>

Response XML

In case of success:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<licenseSession>
	<licenseSessionId>
		YJXgroC%2F7Ng5lYgo2eCrtFaPjv7Gz1X7V2dulSgLgeDXqrfgz7oUz%2B1zZIqt50%2FnS2UYatwdLoVB%0D%0A%2FVFd8hQRjn4O06TM0bf%2FZHm21hZBt2ad2d4M2TzPnXkredifNrFTvGdCP75MyuhOstuFD6492Crk%0D%0AJHzWa0PhOVFjnr7dVYRBC4OTYpC3sXCGAbU%2BE55uqxv3uLF85WV60n4Hr79BbU1ffy%2FeOHMFm1uR%0D%0AChH7yT6X3aBuLQcQ1wAATLUq5ht38v9Ow7MkkBI4Km9ltvHnZ2lhAeI%2BOkSJ
	</licenseSessionId>
</licenseSession>

In case of error:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<error>
	<status>Fail</status>
	<errorCode>error_code</errorCode>
	<errorDescription>error_message</errorDescription>
</error>

Elements in the Response XML

Response Schema

<?xml version="1.0"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema">
	<xs:element name="licenseSession">
		<xs:complexType>
			<xs:sequence>
				<xs:element type="xs:string" name="licenseSessionId" minOccurs='1' maxOccurs='1'/>
			</xs:sequence>
		</xs:complexType>
	</xs:element>
</xs:schema>