Edit mirror authorization

Update the permissions that users and groups have on the vaults in a mirror in the dsNet. Also, provide or deny anonymousPermissions.

Request

Security

Table 1. Roles capable of executing the Edit Mirror Authorization (editMirrorAuthorization) API method
Any Super User System Admin Security Admin Operator
  superUser   securityAdmin  

HTTP method

POST /manager/api/{apiResponseType}/1.0/editMirrorAuthorization.adm HTTP/1.1 Host:{manager.dsnet} id={mirrorId}&anonymousPermission={disabled|readOnly|readWrite|owner}&userPermissions[{userId}]=readWrite&groupPermissions[{groupId}]=readWrite

Curl method

curl -u {admin}:{password} -k ”https://{manager.dsnet}/manager/api/{apiResponseType}/1.0/editMirrorAuthorization.adm“ -d ”id={mirrorId}&anonymousPermission={disabled|readOnly|readWrite|owner}&userPermissions[{userId}]=readWrite&groupPermissions[{groupId}]=readWrite“

Parameters

Table 2. Request Parameters for Edit Mirror Authorization (editMirrorAuthorization) API method
Parameter Type Usage Default Description
id Long Required  

ID of mirror.

userPermissions Map[{userId}] Optional  

A map of user IDs to mirror permissions.

Mirror permission types include:

  • disabled
  • readOnly
  • readWrite
  • owner

User IDs are passed as a hash with the user's ID as key and permission as value.

userPermissions[{userId}]={permission}

groupPermissions Map[{groupId}] Optional  

A map of group IDs to mirror permissions.

Mirror permission types include:

  • disabled
  • readOnly
  • readWrite
  • owner

Group IDs are passed as a hash with the group's ID as key and permission as value.

groupPermissions[{userId}]={permission}.

anonymousPermission String Optional  

Mirror permission to assign to an anonymous user.

Response

Returns success or failure status.

HTTP response codes

  • When using an incorrect mirror ID, the request responds with the 422 HTTP status code and the The given mirror id is invalid HTTP status message.

JSON response example

{
  ”responseStatus“: ”ok“,
  ”responseHeader“: {
    ”status“: ”ok“,
    ”now“: 1399577922741,
    ”requestId“: ”U2vdQsCoDkMAACkJCP0AAAAI“
  },
  ”responseData“: {}
}