Activate platform-managed access
- Technical writer
- Technical writer (Unlicensed)
Description
The platform will, on behalf of the user, accept and sign the agreement needed to activate a platform-managed access. Note that the access must be created as platform-managed, and with the state INVITED. If the activation was successful, the access state will change from INVITED to ACTIVE. To retrieve the user agreement that this API is to accept and sign, use the API GET /server/access/{accessId}/user-agreement-for-activation.
HTTP method | URI scheme |
|---|---|
POST | /server/access/{accessId}/activate |
Parameters
Type | Name | Description | Qualification | Schema |
|---|---|---|---|---|
Path | accessId | The ID of the platform-managed access to activate. | Required | string |
Responses
HTTP code | Common messages | Description | Schema |
|---|---|---|---|
200 |
| The activated 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 activate 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 |
500 | An unexpected error occurred: An unknown error has occurred | This error is returned if an ID in the access, for example the private ID, is not correct. | String |
Security
Type | Name |
|---|---|
apiKey |
Copyright © 2021–2024 Lequa Net AB – a subsidiary of Extracticon AB (publ). All rights reserved.