POST /platforms/:platform/groups

[davidraker]

Create a new group on the specified platform.

The route to the new resource will be returned in the Location header of the response.

Note: Attempting to create a group with a name which already exists will return 409 Conflict with a Content-Location header pointing to the route of the conflicting record.

Request:

• Authorization: BEARER <jwt_token>
  • Content Type: application/json
  • Body:

    {
        "group_name": "<group>",
        "roles": {
            <role>,
            <role>,
            ...
        }
    }
    

Response:

• With valid BEARER token on success: 201 Created
  • Location: /platforms/:platform/groups/:group
• With valid BEARER token if group name already exists: 409 Conflict
  • Content Type: application/json
  • Content-Location: /vui/platforms/:platform/groups/:group_name
  • Body:

    {
        "error": "Unable to create group: :group_name, as this group name already exists."
    }
    

• With valid BEARER token on failure: 400 Bad Request
  • Content Type: application/json
  • Body:

    {
        "error": "<Error Message>"
    }
    

• With invalid BEARER token: 401 Unauthorized