Changing the forbidden permissions for a user via the API requires specific syntax depending on whether you are using REST or SOAP. Use this table to find the syntax for your command.
Understanding How The API Works »
REST Syntax
Click to view all REST Resources |
UserForbidEntry/ PUT — Replaces the list of forbidden permissions in the user’s permissions group with a new list.
HTTP Action — PUT
URI — https://api.dynect.net/REST/UserForbidEntry/<user_name>/
|
Arguments — Click for More Info
- array
forbid — A list of rules to replace the forbidden rules on the user’s permission group. If empty or not passed in, the user’s forbid list will be cleared.
- string
name — Required. The name of the permission(s) forbidden to the user.
- array
zone — A list of zones where the forbid rule(s) apply.
- string
zone_name — Required. The name of the zone or FQDN where the forbidden rule(s) apply.
- string
recurse — Indicates whether or not the forbid rule should apply to subnodes of the zone_name as well.
Valid values:
Y – Permissions should apply to zone_name and any nodes below zone_name .
N – Permissions should apply only to zone_name .
|
Response:
Not Applicable.
|
SOAP Syntax
Click to view all SOAP Commands |
SetUserForbids — Replaces the list of forbidden permissions in the user’s permissions group with a new list.
|
Arguments — Click for More Info
- string
user_name – Required. The user’s name.
- array
forbid — A list of rules to replace the forbidden rules on the user’s permission group. If empty or not passed in, the user’s forbid list will be cleared.
- string
name — Required. The name of the permission(s) forbidden to the user.
- array
zone A list of zones where the forbidden rule applies.
- string
zone_name — Required. The name of the zone or FQDN where the forbidden rule(s) apply.
- string
recurse – Indicates whether or not the forbidden rule should apply to subnodes of the zone_name as well.
Valid values:
Y – Permissions should apply to zone_name and any nodes below zone_name .
N – Permissions should apply only to zone_name .
- string
token — Required. The session identifier.
|
Response:
Not Applicable.
|
Example Request — Click for More Info
{
'token' => 'asdlj34ot879834cdzjklfK',
'user_name' => 'user1',
'forbid' => [
{
name => 'RecordGet'
}, {
name => 'RecordUpdate',
zone => [
{
zone_name => 'test.com',
recurse => 'N'
},
],
},
],
}
|
DNS API Knowledge Base