Users
URL Endpoint
HTTPS://api.adaptiveplanning.com/api/rest/security/<version>/<tenant>/users/<userGUID>
Version: v1
Category
| Data Update |
Description
| Delete user from Adaptive Planning. |
Permissions Required To Invoke
| Admin access > Users |
Parameters Required On Request
| userGUID |
REST API that enables the deletion of users from planning with appropriate user permissions and company configuration. Blocked for instances configured to use Adaptive Planning with Workday HCM or Workday Financials.
Supported HTTP VERB(s)
HTTP Verb | Single Resource | Collection Resource | Description |
|---|---|---|---|
DELETE
| Supported | Not Supported | Deletes a user from planning. |
Request
- Supported Methods:
- DELETE/users/<userGUID>Deletes a user from planning. You can filter by instanceCode.Sample Request URI:https://api.adaptiveplanning.com/api/rest/security/v1/globosales/users/EEDDEEDDEEDDEEDDEEDDEEDDEEDDEEDDSample Request Header:Sample Request Body:Query ParametersNameDescriptionRequireduserGUIDalphanumeric unique identifier for a user.YinstanceCodeThe instanceCode to retrieve a user instance. For example, GLOBO. If no instanceCode is specified, uses the default instance.N
- Sample Response:
- 200Successful response.401Invalid instance code.Sample Error Response: 401{ "error": "Invalid credential" }403 ForbiddenUser has insufficient permissions.500 Internal Server ErrorInternal Server Error.Sample Error Response: 500{ "error": "Delete User API failed for instance code GLOBO.", "code": 500 }