API v2: Object Rights 🆕

Data Structures

ObjectRightsModels

Attribute	Type	Required	Description
name	string	yes	Read-only.
description	string	yes	Read-only.

Request for Retrieving Available Attributes of the Object- RightsModels

Request

Method	GET
Path	/api/v2/objspec/{objtype}_right
Variants	/api/v2/objspec/account_right /api/v2/objspec/group_right /api/v2/objspec/pool_right /api/v2/objspec/safe_right /api/v2/objspec/server_right /api/v2/objspec/user_right

To check allowed methods, available URL parameters and possible responses please refer to the API Overview section.

Get Available Rights Values for Object Types

Request

Method	GET
Path	/api/v2/capability/right/{objtype}
Variants	/api/v2/capability/right/account /api/v2/capability/right/group /api/v2/capability/right/pool /api/v2/capability/right/safe /api/v2/capability/right/server /api/v2/capability/right/user

Example Request

GET /api/v2/capability/right/account

curl -s -k -X GET \
  -H 'Authorization:sgfeea6jsaz4mum9su8w6' \
  'https://10.31.87.227/api/v2/capability/right/account'

Response

{
    "result": "success",
    "account_right": [
        {
            "name": "read",
            "description": ""
        },
        {
            "name": "modify",
            "description": ""
        },
        {
            "name": "delete",
            "description": ""
        },
        {
            "name": "block",
            "description": ""
        }
    ]
}

The table below lists the available rights values for each object type.

Object type	Available rights values
account	"read" "modify" "delete" "block"
group	"read" "modify" "delete" "user-add" "user-remove"
pool	"read" "modify" "delete" "server-add" "server-remove"
safe	"read" "modify" "delete" "block" "account-add" "account-remove" "group-add" "group-remove" "user-add" "user-remove"
server	"read" "modify" "delete" "block"
user	"read" "modify" "delete" "block" "session-view"