...
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 method | URI scheme |
|---|---|
GET | /server/access/{accessId}/user-agreement-for-activation |
Parameters
Type | Name | Description | Qualification | Schema |
|---|---|---|---|---|
Path | accessId | The ID of the platform-managed access to get the user agreement for. | Required | string |
Responses
HTTP code |
|---|
Common messages | Description | Schema | |
|---|---|---|---|
200 | The user agreement that the user needs to accept to activate the access. | ||
400 | The application with the specified key could not be found |
String | |
Input not valid: Access ID ' |
<%1>' is not in the correct format | The ' |
<%1>' (in single quotes, without |
angle brackets) refers to the value entered as the access ID in the request. |
String |
The access must be in the INVITED state for the application to be able to get the user agreement for it. |
String | |
The access must be platform-managed for the application to be able to activate it. |
String | |
404 | The access with |
ID <%1> was not found | No access with the specified ID was found. |
The <%1> (without single quotes, without |
angle brackets) refers to the value entered as the access ID in the request. |
String |
Security
Type | Name |
|---|---|
apiKey |