Delete User Group Users

DELETE /user-groups/{id}/users

Bearer auth

This API call removes the specified list of users from a user group.

Path parameters

id integer Required

User group ID.

application/json

Body Required

users array[string]

Comma separated List of usernames.

Responses

200 application/json

Success Response
Hide response attributes Show response attributes object
- id integer
  
  User group id.
- status string
  
  Status of request.
- messages array[string]
  
  List of failure reasons.
400 application/json

Failed Response
Hide response attributes Show response attributes object
- id integer
  
  User group id.
- status string
  
  Status of request.
- messages array[string]
  
  List of failure reasons.
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.
404 application/json

Failed Response

DELETE /user-groups/{id}/users

curl \
 --request DELETE 'https://localhost:8080/user-groups/1/users' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/json" \
 --data '{"users":["javarro","bribbon","tsanchez"]}'

Request example

{
  "users": [
    "javarro",
    "bribbon",
    "tsanchez"
  ]
}

Response examples (200)

{
  "id": 12,
  "status": "Success",
  "messages": [
    "User group users deleted successfully."
  ]
}

Response examples (400)

{
  "status": "Failure",
  "messages": [
    "Default user 'jbond' cannot be removed.  Change default user first before removing."
  ]
}

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"
}

Response examples (404)

{
  "error": "User group not found",
  "status": 404
}