Delete User Group

DELETE /user-groups/{id}
Bearer auth

This API call deletes a user group.

Path parameters

  • id integer Required

    User group ID.

Responses

  • 200 application/json

    Success Response

    Hide response attributes Show response attributes object
    • id integer

      Unique identifier of user group

    • name string

      Name of user group.

    • status string

      Status of user group processing.

    • message string

      Status message of user group processing.
  • 400 application/json

    Failed Response

    Hide response attributes Show response attributes object
    • id integer

      Unique identifier of user group

    • name string

      Name of user group.

    • status string

      Status of user group processing.

    • message string

      Status message of user group processing.
  • 401 application/json

    Authentication Error. Invalid credentials.

    Hide response attributes Show response attributes object
  • 403

    Authorization Error. Invalid role for request.

  • 404 application/json

    Failed Response

DELETE /user-groups/{id} 
curl \
 --request DELETE 'https://localhost:8080/user-groups/1' \
 --header "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200) 
{
  "id": 12,
  "status": "Success",
  "message": "User group deleted successfully."
}
Response examples (400) 
{
  "status": "Failure",
  "messages": [
    "User group cannot be deleted. User group is used in JE Approver Routing.",
    "User group cannot be delete. User group is used by JE Template Control."
  ]
}
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
}