Remove User Operational Structures

DELETE /users/{userName}/operational-structures

Bearer auth

This API is used to remove the Match operational structure(s) for the specified user.

Path parameters

userName string Required

Username of the user.

application/json

Body Required

operationalStructureIds array[integer]

The list of operational structure id(s).

Responses

200 application/json

Successful Response
401 application/json

Authentication Error. Invalid credentials.
Hide response attributes Show response attributes object
- code string
- message string
- description string
403

Authorization Error. Invalid role for request.

DELETE /users/{userName}/operational-structures

curl \
 --request DELETE 'https://localhost:8080/users/testuser1/operational-structures' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/json" \
 --data '{"operationalStructureIds":[2,4,10]}'

Request example

{
  "operationalStructureIds": [
    2,
    4,
    10
  ]
}

Response examples (200)

{
  "status": "Success",
  "messages": "Match user operational structure(s) removed successfully."
}

Response examples (401)

{
  "code": "900901",
  "message": "Invalid Credentials",
  "description": "Access failure for API: /api/admin/v1.1.0, version: v1.1.0 status: (900901) - Invalid Credentials. Make sure you have provided the correct security credentials"
}