...
On behalf of the user, the platform retrieves and returns the agreement that is to be accepted and signed when activating a platform-managed access. Note that the access must be created as platform-managed, and with the state INVITED. To accept the user agreement returned by this API and activate the access, use the API POST /server/access/{accessId}/activate.
| HTTP Methodmethod | URI Schemescheme |
|---|---|
| GET | /server/access/{accessId}/user-agreement-for-activation |
...
| Type | Name | Description | Qualification | Schema |
|---|---|---|---|---|
| Path | accessId | The ID of the platform-managed access to get the user agreement for. | Required | string |
Responses
| HTTP Codecode | Message | Description | Schema | ||||
|---|---|---|---|---|---|---|---|
| 200 | The user agreement that the user needs to accept to activate the access. | UserAgreementForActivation | 400 | Remove, string message mentioned below. | The reason could be, for instance, that the access is not platform-managed or that it is not in the INVITED state. See error response for details. | ||
| 400 | The application with the specified key could not be found | 400string | |||||
| Input not valid: Access ID '[…]' is not in the correct format | The '[…]' (in single quotes, without square brackets) refers to the value entered as the access ID in the request. | 400string | |||||
| The access must be in the INVITED state for the application to be able to get the user agreement for it. | 400string | ||||||
| The access must be platform-managed for the application to be able to activate it. | string | ||||||
| 404 | The access with ID […] was not found | No access with the specified ID was found. The […] (without single quotes, without square brackets) refers to the value entered as the access ID in the request. | string |
...