Loading...

Update Entity Security Associations (REST API : POST)

This operation updates the security associations for an entity. The entity, role, and user form a security association.

Request

Syntax

POST <webservice>/Security HTTP/1.1
Host: <host name>
Accept: {application/xml | application/json}
Authtoken: <authentication token>
Content-type: application/json

<update_entity_security_template.json>

where <webservice> is the root path used to route the API requests to the Web Server.

For more information, see Available Web Services for REST API.

Request Headers

Name

Description

Host

The host name of the Web Server or Web Console used in the API request.

Accept

The format of the response. Valid values are: application/xml or application/json.

Authtoken

The authentication token received after successfully logging on. For details on receiving an authentication token, see Authentication.

Content-type

The media type contained in the request body.

Request Body

Download the JSON file required for this request: update_entity_security_template.json. The following table displays the parameters for the request body.

Parameter

Description

Element

Parent Element

entityType

The type of entity.

Valid values are:

  • 3, client
  • 28, client group
  • 4, agent
  • 5, instance
  • 6, backup set
  • 7, subclient
  • 17, storage policy entity
  • 35, schedule policy
  • 64, alert
  • 83, workflow
  • 158, plans

entity

entityAssociated

_type_

Valid value is 150.

entity

entityAssociated

entityId

The system-generated ID assigned to the entity. Use the appropriate GET API to retrieve the ID for the entity. For example, if you want to update the security association for a plan, use the GET Plan API.

entity

entityAssociated

associationsOperationType

The operation to perform on the role and user inside the <associations> block. The entity, role, and user form a security association.

Valid values are:

  • ADD, to create a new security association between the entity, role, and user
  • OVERWRITE, to overwrite existing security associations with new security associations
  • DELETE, to delete one or more security associations

securityAssociations

 

userGroupId

The system-generated ID assigned to the user group. To add, overwrite, or delete a user group in a security association, you can use the userGroupName parameter or the userGroupId parameter.

userOrGroup

associations

userGroupName

The name of the user group. To add, overwrite, or delete a user group in a security association, you can use the userGroupName parameter or the userGroupId parameter.

userOrGroup

associations

userId

The system-generated ID assigned to the user. To add, overwrite, or delete a user in a security association, you can use the userName parameter or the userId parameter.

userOrGroup

associations

userName

The name of the user. To add, overwrite, or delete a user in a security association, you can use the userName parameter or the userId parameter.

userOrGroup

associations

roleId

The system-generated ID assigned to the role. If the role ID is not known, use the GET Role API to retrieve it.

role

properties

Response

Response Parameters

Parameter

Description

Element

warningCode

The possible warning codes.

Valid values are:

  • 0, successful completion.
  • 2, a failure.
  • a specific warning code.

response

errorCode

The possible error codes.

Valid values are:

  • 0, successful completion.
  • 2, a failure.
  • a specific error code.

response

warningMessage

The description of the warning code. Not all warning codes have a warning message.

response

Examples

Sample Request

This request adds a security association to a plan.

POST <webservice>/Security HTTP/1.1
Host: client.mydomain.com
Accept: application/json
Authtoken: QSDK 38568012f4d1e8ee1841d283a47aa3ba78e124ea58354b5fc6
0f4dab8a63347d05cf5552484dafda3bfa4c5db84e580b1cb37bcf8e65b39f7f
8549a443e6f78a2c7be3f31b3d845e24776c835e498e8e883bb40c46bd15af4f
40ca94e823acedcdd4e9659e74b34a07a85c4586cd2ed914b6dce015874783ef7
68fda78183a4208930954a377f66eb56c8b92cexampl4s437a19317ca6ce7f323
3d5a01aca35dbad93468b833f2cf71010809006a937670adce711ca8be46638e8
Content-type: application/json

{
  "entityAssociated": {
    "entity": [{
      "entityType": 158,
      "_type_": 150,
      "entityId": 10
    }]
  },
  "securityAssociations": {
    "associationsOperationType": "ADD",
    "associations": [{
      "userOrGroup": [{
        "userName": "RSmith"
      }],
      "properties": {
        "role": {
          "roleId": 3,
        }
      }
    }]
  }
}

Sample Response

{
  "response": [{
    "warningCode": 0,
    "errorCode": 0,
    "warningMessage": ""
  }]
}

Last modified: 6/28/2018 8:27:45 PM