POST registration
Used to register the software vendor node with Directory Service. The Directory Service searches the Cloud Connect URL for the provisioned software vendor node, and returns it.
You need to store the SCC URL received from the POST registration request to perform operation on other resources (License Session and License).
Guidelines on handling the Cloud Connect URL
In an application's lifecycle, the POST registration request should be placed once at the beginning of an application to get the SCC URL. This is required to consume and license resources. However, if any of the following error is reported from a resource other than registration, you need to get the updated SCC URL again from YPS:
>HTTP 401 due to the errors 2027 and 2028 in the response body.
>HTTP 404
The following pseudo code algorithm updates the SCC URL, and ensures calls to YPS are made in an optimal manner as there can be many concurrent requests and there is no need to send to all the requests to YPS.
Method to update stored SCC url
If (current time - last yps request time ) > X [60 seconds])
lock(timeout 1 second]
send request to yps
last yps request time = current time
update stored scc url
Note the following:
>The above algorithm is not mandatory. However, if SCC update is not handled properly, the client application will need to be restarted.
>The SCC URL change does not happen frequently, for example, it may change once in a year.
>YPS URL never changes.
Type
POST
URI
<YPS_URL>/registrations
The <YPS_URL> represents the URL of Directory Services (also called, YPS) as received in Sentinel Order emails from Thales.
Example URI
https://fra01-he02.trial.sentinelcloud.com/YPServer/registrations
URI Parameter
None
Request Body
None
Response Body
In case of success:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<registration>
<url>https://fra01-he02.trial.sentinelcloud.com/scc</url>
<registrationId>93c6ac40-80d7-4c32-b89b-1e37d56a1a8f</registrationId>
</registration>
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>
NOTE PUT, GET, and DELETE operations are not allowed.
Elements in the Response Body
The following table describes the elements present in the output XML:
Element | Description |
---|---|
url | The Cloud Connect URL returned by the Directory Services. |
registrationId | A unique ID that represents the created resource. |
Response Schema
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:element name="registration">
<xs:complexType>
<xs:sequence>
<xs:element type="xs:string" name="url" minOccurs='1' />
<xs:element type="xs:string" name="registrationId" minOccurs='1' />
</xs:sequence>
</xs:complexType>
</xs:element>
</xs:schema>
Error Codes
Error Code | Description | Status Code |
---|---|---|
2031 |
No authorization server mapped to given vendorId |
403 Forbidden |
See Also: Common Error Codes