Select the tab
ESET Connect – Table of Contents

GET Get policy assignment

Relative path: /v2/policy-assignments/{assignmentUuid}

Get details of the given policy assignment.

Parameters in path

Name

Type

Required

Description

assignmentUuid

string

Yes

Reference to the policy assignment to retrieve.

type: PolicyAssignment

Responses

Display Schema instead of an Example or vice-versa

Code

Description

Example

Schema

200

Successful response.

 
{
  "assignment": {
    "policyUuid": "string",
    "rank": 0,
    "target": {
      "deviceUuid": "string",
      "deviceGroupUuid": "string",
      "subscriptionUuid": "string"
    },
    "uuid": "string"
  }
}
 
{
  "$ref": "v2GetPolicyAssignmentResponse",
  "assignment": {
    "$ref": "v2PolicyAssignment",
    "description": "Relation between policy and target. One target can have multiple policies assigned. Those policies are combined according to their ranking.",
    "policyUuid": {
      "type": "string",
      "description": "Assigned policy. type: Policy"
    },
    "rank": {
      "type": "integer",
      "description": "Ranking within multiple assignments to the target. Rank 1 is the highest rank, that is, the rank of the highest priority. Policies are applied in order from the highest rank to the lowest.",
      "format": "int64",
      "readOnly": true
    },
    "target": {
      "$ref": "v2PolicyTarget",
      "description": "Identifies the entity to which the policy is assigned.",
      "deviceUuid": {
        "type": "string",
        "description": "Policy is assigned to [device]. type: device_management.v1.Device"
      },
      "deviceGroupUuid": {
        "type": "string",
        "description": "Policy is assigned to [device group]. type: device_management.v1.DeviceGroup"
      },
      "subscriptionUuid": {
        "type": "string",
        "description": "Policy is assigned to [subscription]. type: subscription_provisioning.v2.Subscription"
      }
    },
    "uuid": {
      "type": "string",
      "description": "Unique identifier of the entity. Must be collision-free - two identifiers created anywhere in the world must not collide within entity parent scope. Unless a member of aggregate, the entity scope is always global. Although most of the times compliant with RFC 4122: A Universally Unique IDentifier (UUID) URN Namespace, do not rely on it being a RFC UUID. Treat it as an opaque identifier. RFC UUID can be recognized by being formatted according to the template xxxxxxxx-xxxx-Mxxx-Nxxx-xxxxxxxxxxxx, as explained on Wikipedia. UUID is used for referencing an entity, even across domains. Example: '123e4567-e89b-12d3-a456-426614174000'",
      "readOnly": true
    }
  }
}

202

Response took too long; request cached. Response can be retrieved later using the response-id header.

 
null
 
[]

400

One of the errors: 1. Bad or missing authorization. 2. Validation error. Invalid argument provided.

 
null
 
[]

401

Token has expired or is invalid.

 
null
 
[]

403

Access denied. Check permissions.

 
null
 
[]

404

Requested resource not found.

 
null
 
[]

429

Rate limit reached. Try again later.

 
null
 
[]

500

Internal server failure. Try again later.

 
null
 
[]

502

Internal server failure. Try again later.

 
null
 
[]

503

Environment under maintenance. Try again later.

 
null
 
[]

504

Action took too long; timeout reached

 
null
 
[]