Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Description

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 methodURI scheme
GET/server/access/{accessId}/user-agreement-for-activation

Parameters

TypeNameDescriptionQualificationSchema
PathaccessIdThe ID of the platform-managed access to get the user agreement for.Requiredstring

Responses

HTTP codeMessageDescriptionSchema
200
The user agreement that the user needs to accept to activate the access.UserAgreementForActivation
400The application with the specified key could not be found
string
Input not valid: Access ID '[…]' is not in the correct formatThe '[…]' (in single quotes, without square 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
404The access with ID […] was not foundNo 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

Security

TypeName
apiKeyKey