Manage Srm Permissions

Manage Srm Permissions

Adds or modifies a permission rule from a given Site Recovery Manager object.

Request
URI
PUT
https://{api_host}/pairings/{pairing_id}/srms/{srm_id}/permissions
COPY
Path Parameters
string
pairing_id
Required

The ID of a pairing between this Site Recovery Manager server and remote one.

string
srm_id
Required

ID of a Site Recovery Manager server.

Query Parameters
string
object_id
Optional

Entity on which a permission is added or modified. If not provided, the permission is added or modified on the Site Recovery Manager server.


Request Body

Spec describing the user or group for which the permission is added or modified.

ManagePermissionSpec of type(s) application/json
Required

Show optional properties

{
    "principal": "string",
    "role_name": "string"
}
{
    "principal": "string",
    "role_name": "string",
    "propagate": false,
    "group": false
}
string
principal
Required

User or group receiving access in the form of "login".

string
role_name
Required

The label for the role in a string format.

boolean
propagate
Optional

Defines whether the role is propagated to the children of the entity.

boolean
group
Optional

Whether principal refers to a user or a group. True for a group and false for a user.

Authentication
This operation uses the following authentication methods.
Responses
204

The permission was successfully modified.

Operation doesn't return any data structure

400

Bad request - the server cannot understand the request due to invalid syntax or invalid request body content

Returns ResponseError of type(s) application/json
"ResponseError Object"
string
error_code
Optional

The code of the error.

string
message
Optional

The message of the error.

string As uuid As uuid
op_id
Optional

The ID of the operation.


401

Unauthorized - the client must authenticate itself to get the requested response

Operation doesn't return any data structure

403

Forbidden - not sufficient access rights to fulfill the request

Returns ResponseError of type(s) application/json
"ResponseError Object"
string
error_code
Optional

The code of the error.

string
message
Optional

The message of the error.

string As uuid As uuid
op_id
Optional

The ID of the operation.


404

Not Found - server cannot find the requested in URL resource

Operation doesn't return any data structure

500

Internal server error - unexpected condition prevents fulfilling the request

Returns ResponseError of type(s) application/json
"ResponseError Object"
string
error_code
Optional

The code of the error.

string
message
Optional

The message of the error.

string As uuid As uuid
op_id
Optional

The ID of the operation.


Code Samples
COPY
                    curl -X PUT -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"principal:"string","role_name:"string"}' https://{api_host}/pairings/{pairing_id}/srms/{srm_id}/permissions