Deleting a User Group

Function

This API is used to delete a user group.

URI

  • URI format

    DELETE /v3/groups/{group_id}

  • URI parameters

    Parameter

    Mandatory

    Type

    Description

    group_id

    Yes

    String

    ID of a user group.

Request Parameters

  • Parameters in the request header

    Parameter

    Mandatory

    Type

    Description

    Content-Type

    Yes

    String

    Fill application/json;charset=utf8 in this field.

    X-Auth-Token

    Yes

    String

    Authenticated token with the Security Administrator permission.

  • Example request

    curl -i -k -H 'Accept:application/json' -H 'Content-Type:application/json;charset=utf8' -H "X-Auth-Token:$token" -X DELETE https://sample.domain.com/v3/groups/aaec2abd4eba430fbf61541ffde76650
    

Response Parameters

None

Status Codes

Status Code

Description

204

The user group is deleted successfully.

400

The server failed to process the request.

401

Authentication failed.

403

Access denied.

404

The requested resource cannot be found.