Get Permission Rule

Get Permission Rule

Retrieves details for a specific permission rule. Each rule contains information about the principal and the access rights assigned.

Request
URI
GET
https://{api_host}/vco/api/server/permissions/{ruleId}
COPY
Path Parameters
string
Required
string
Required
Responses
200

The request is successful

Returns permission of type(s) application/json 
{
    "principal": "string",
    "rights": "string",
    "href": "string",
    "relations": {
        "total": 0,
        "start": 0,
        "link": [
            {
                "rel": "string",
                "attribute": [
                    {
                        "displayValue": "string",
                        "name": "string",
                        "value": "string"
                    }
                ],
                "href": "string",
                "type": "string"
            }
        ]
    }
}
string
principal
Optional

principal

string
rights
Optional

rights

string
href
Optional

href

Relations
relations
Optional

relations


401

The user is not authorized.

Operation doesn't return any data structure

404

The user does not have 'read' access rights for the server object, or the permission rule with the specified ID does not exist.

Operation doesn't return any data structure

On This Page
Orchestrator Server Instance Service Operations
DELETE
Delete Permission Rule
DELETE
Delete Permissions For Object
GET
Enumerate Services
GET
Get Authentication
GET
Get Groups
GET
Get Permission Rule
GET
Get Permissions For Object
POST
Insert Permissions For Object
PUT
Update Permission Rule