Assign Or unassign AppStacks To A target

Assign or unassign AppStacks to a target

Request

URI

POST

https://{api_host}/cv_api/assignments

COPY

Request Body

{
    "id": 0,
    "action_type": "unassign",
    "assignments": [
        {
            "entity_type": "Group",
            "path": "CN=test1,CN=Users,DC=test,DC=local"
        }
    ],
    "mount_prefix": "DESK",
    "rtime": false
}

integer

Required

The ID of the AppStack to assign or unassign.

string

action_type

Required

Specifies whether to assign or unassign the assignment entities.

Possible values are : assign, unassign,

array of AssignmentsArray

assignments

Required

assignments

string

mount_prefix

Optional

Prefix for computer names. Assignments only apply to computers whose name begins with the prefix.

boolean

rtime

Optional

Whether to perform the operation in real-time. Users must be logged into a VM to have AppStacks assigned immediately. Unassigning an AppStack while it is in use is not recommended, please ensure the AppStack is no longer in use.

Responses

200

Result of assignment/unassignment. Ignored assignments/unassignments are indicated as warnings.

{
    "success": "Unassigned 1 AppStack(s)",
    "successes": [
        "Unassigned 1 AppStack(s)",
        "Unassigned AppStack"
    ],
    "warning": "Unable to find 2 AppStacks",
    "warnings": [
        "Unable to find AppStacks",
        "Unable to find AppStacks"
    ]
}

string

success

Optional

success

array of successes

successes

Optional

successes

string

warning

Optional

warning

array of warnings

warnings

Optional

warnings

400

Unable to assign/unassign due to invalid parameters.

{
    "error": "No entities provided"
}

string

error

Optional

error

403

Session expired. Create a session and make the request with the _session_id cookie.

Returns UnauthorizedError of type(s) application/json

{
    "error": "Session expired. Please login again."
}

string

error

Optional

Session expired. Create a session using and make the request with the _session_id cookie.

500

Unexpected failure.

{
    "error": "Assigned AppStacks failed",
    "errors": [
        "Unable to save assignment of \"User <SNAPVOLUMES\\test_user-45>\" to \"Volume-55\"",
        "Unable to save assignment of \"User <SNAPVOLUMES\\test_user-46>\" to \"Volume-56\""
    ]
}

string

error

Optional

error

array of errors

errors

Optional

errors

On This Page

Description

Request

Request Body