Description
Creates an access for a user. For a platform-managed access in the INVITED state, the application also needs to activate the access before it can be used. This can be done with the API POST /server/access/{accessId}/activate.
| HTTP method | URI scheme |
|---|---|
| POST | /server/access |
Parameters
| Type | Name | Description | Qualification | Schema |
|---|---|---|---|---|
| Body | request | Request body parameters, see schema for details. | Required |
Responses
| HTTP code | Common messages | Description | Schema |
|---|---|---|---|
| 200 | The created access. | ||
| 400 | The application with the specified key could not be found | String | |
| Input not valid: First name and last name must always be specified. | String | ||
| Input not valid: Type, private ID and managed must be specified when creating an access. | String | ||
| Input not valid: Corporate ID must be specified when creating access of type CORPORATE. | String | ||
| Input not valid: Corporate ID can not be specified when creating access of type PRIVATE. | String | ||
| Input not valid: Access ID can not be specified when creating an access. | String | ||
| Input not valid: State can not be specified when creating an access. | String | ||
| 500 | An unexpected error occurred: Required request body is missing <%1> | This error occurs when the required Access is not sent. | String |
An unexpected error occurred: JSON parse error <%1> | This error message can be returned when the parameters are not specified properly or are of wrong type. | String | |
An unexpected error occurred: An unknown error has occurred | This error message can be returned when the parameters are not specified properly or are of wrong type. For example, the unknown error is returned if the ID of the private identity is not correct. Refer to Access for more details. | String |
Security
| Type | Name |
|---|---|
| apiKey | Key |