Versions Compared

Key

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

WIP

Description

...

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 CodeDescriptionSchema
200The user agreement that the user needs to accept to activate the access.UserAgreementForActivation
400The 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.No content
404No access with the specified ID was found.No content

Security

TypeName
apiKeyKey