Base path: [ENVIRONMENT_URL]/rest/enterprises
Send "Accept" HTTP header to specify content format. Possible values are "application/xml" for XML format, "application/json" for JSON format, and "text/plain" for text format (where permitted for simple string, boolean, and numeric responses).
Default response format is "application/xml".
Use BASIC authorization.
| Description: | Creates a user account and single sign on token. Returns the SSO ID which must be stored securely in the client application. | |||
| Method: | POST | |||
| Path: | [ENVIRONMENT_URL]/cpservice/rest/enterprises/sso | |||
| Parameters: | Name | Type | Source | Description |
| firstName | String | Form parameter firstName | First Name | |
| lastName | String | Form parameter lastName | Last Name | |
| String | Form parameter email | |||
| Returns: | String | |||
| Sample: |
POST https://secure.cloudpiston.com/cpservice/rest/enterprises/sso HTTP/1.1
firstName=John&lastName=Smith&email=John.Smith@contractpal.com
| |||
| Description: | Deletes SSO | |||
| Method: | POST | |||
| Path: | [ENVIRONMENT_URL]/cpservice/rest/enterprises/sso/delete | |||
| Parameters: | Name | Type | Source | Description |
| sso | String | Form parameter sso | SSO token | |
| Sample: |
POST https://secure.cloudpiston.com/cpservice/rest/enterprises/sso/delete HTTP/1.1
sso=SSO-11A4FD35049-30E75B79
| |||
| Description: | Creates SSO for a registered user and sends an email invitation. The user must activate the SSO before it can be used by the client application. | |||
| Method: | POST | |||
| Path: | [ENVIRONMENT_URL]/cpservice/rest/enterprises/sso/invite | |||
| Parameters: | Name | Type | Source | Description |
| String | Form parameter email | |||
| Returns: | String | |||
| Sample: |
POST https://secure.cloudpiston.com/cpservice/rest/enterprises/sso/invite HTTP/1.1
email=test%40contractpal.com
| |||
| Description: | Return true if the email is already registered. | |||
| Method: | GET | |||
| Path: | [ENVIRONMENT_URL]/cpservice/rest/enterprises/sso/registered | |||
| Parameters: | Name | Type | Source | Description |
| String | Form parameter email | |||
| Returns: | boolean | |||
| Sample: |
GET https://secure.cloudpiston.com/cpservice/rest/enterprises/sso/registered?email=user@domain.com HTTP/1.1
| |||
| Description: | Returns status of SSO | |||
| Method: | GET | |||
| Path: | [ENVIRONMENT_URL]/cpservice/rest/enterprises/sso/status | |||
| Parameters: | Name | Type | Source | Description |
| sso | String | Form parameter sso | SSO token | |
| Returns: | String | |||
| Sample: |
GET https://secure.cloudpiston.com/cpservice/rest/enterprises/sso/status?sso=SSO-11A4FD35049-30E75B79 HTTP/1.1
| |||
| Description: | Updates a user account associated with the token. Returns true on success. Note that an email address must be globally unique. | |||
| Method: | POST | |||
| Path: | [ENVIRONMENT_URL]/cpservice/rest/enterprises/sso/update | |||
| Parameters: | Name | Type | Source | Description |
| sso | String | Form parameter sso | SSO token | |
| firstName | String | Form parameter firstName | First Name | |
| lastName | String | Form parameter lastName | Last Name | |
| String | Form parameter email | |||
| Returns: | boolean | |||
| Sample: |
POST https://secure.cloudpiston.com/cpservice/rest/enterprises/sso/update HTTP/1.1
sso=SSO-11A4FD35049-30E75B79&firstName=John&lastName=Smith&email=John.Smith@contractpal.com
| |||