api.accounts.group — Group manipulation

/accounts/group

api.accounts.group.views.group_list(*args, **kwargs)

List (GET) all available groups.

GET /accounts/group
DC-bound?:
Permissions:
Asynchronous?:
Parameters:
  • data.full (boolean) – Return list of all groups with group details (default: false)
  • data.extended (boolean) – Display extended group details (default: false)
  • data.order_by (string) – Available fields for sorting: name (default: name)
Status Codes:

/accounts/group/(name)

api.accounts.group.views.group_manage(*args, **kwargs)

Show (GET), create (POST), update (PUT) or delete (DELETE) details of a group.

GET /accounts/group/(name)
DC-bound?:
  • - dc_bound=true
  • - dc_bound=false
Permissions:
Asynchronous?:
Parameters:
  • name (string) – required - Group name
  • data.extended (boolean) – Display extended group details (default: false)
Status Codes:
POST /accounts/group/(name)
DC-bound?:
  • - dc_bound=true
  • - dc_bound=false
Permissions:
Asynchronous?:
Parameters:
  • name (string) – required - Group name
  • data.alias (string) – Short group name alias (default: name)
  • data.permissions (array) – List of permission names assigned to the group (supports multiple permissions, requires valid permissions, default: [])
  • data.users (array) – Username assigned to the group (supports multiple users, requires valid users, default: [])
  • data.dc_bound (boolean) – Whether the group is bound to a datacenter (requires SuperAdmin permission) (default: true)
  • data.dc (string) – Name of the datacenter the group will be attached to (required if DC-bound)
Status Codes:
PUT /accounts/group/(name)
DC-bound?:
  • - dc_bound=true
  • - dc_bound=false
Permissions:
Asynchronous?:
Parameters:
  • name (string) – required - Group name
  • data.alias (string) – Short group name alias (default: name)
  • data.permissions (array) – List of permission names assigned to the group (supports multiple permissions, overwrites all already assigned permissions, requires valid permissions)
  • data.users (array) – Username assigned to the group (supports multiple users, overwrites all already assigned users, requires valid users)
  • data.dc_bound (boolean) – Whether the group is bound to a datacenter (requires SuperAdmin permission)
Status Codes:
DELETE /accounts/group/(name)
DC-bound?:
  • - dc_bound=true
  • - dc_bound=false
Permissions:
Asynchronous?:
Parameters:
  • name (string) – required - Group name
Status Codes:

es example:

es create /accounts/group/testers -permissions admin,image_admin -users admin,tester@erigones.com -alias 'Testers User Group'
{
    "url": "https://my.erigones.com/api/accounts/group/testers/",
    "status": 201,
    "method": "POST",
    "text": {
        "status": "SUCCESS",
        "result": {
            "alias": "Testers User Group",
            "users": [
                "admin",
                "testerx@erigones.com"
            ],
            "name": "testers",
            "permissions": [
                "admin",
                "image_admin"
            ]
        },
        "task_id": "1e1d1-6f75849b-f4e5-4a88-9d7d"
    }
}