Updating Permission Group settings in 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 |
PermissionGroup/ PUT — Updates data for an existing permissions group.
HTTP Action — PUT
URI — https://api.dynect.net/REST/PermissionGroup/<group_name>/
|
Arguments — Click for More Info
- string
group_name — Required. The name of the permission group to update.
- string
new_group_name — If provided, the new group_name for the permission group.
- string
description — A description of the permission group.
- string
type — The type of the permission group.
Valid values:
plain — A regular permission group.
default — A default permission group. All new users will automatically be added to this group. If user_name isn’t specified, all current users will be added to this group as well.
- string
all_users — If ‘Y’, all current users will be added to the group. Cannot be used if user_name is passed in.
- array
permission — A list of permissions that the group contains.
- array
user_name — A list of users that belong to the permission group.
- array
subgroup — A list of groups that belong to the permission group.
- array
zone — A list of zones where the group’s permissions apply.
- string
zone_name — Required. The name of the zone or FQDN where the permissions apply.
- string
recurse — Indicates whether or not permissions should apply to subnodes of the zone_name .
Valid values:
Y — Permissions apply to zone_name and any nodes below zone_name .
N — Permissions apply only to zone_name .
|
Response — Click for More Info
- string
group_name — The permission group’s name.
- string
description — A description of the permission group.
- string
type — The type of the permission group.
Valid values:
plain — A regular permission group.
default — A default permission group. All new users will automatically be added to this group.
- array
permission — A list of permissions that the group contains.
- array
user_name — A list of users that belong to the permission group.
- array
subgroup — A list of groups that belong to the permission group.
- array
zone — A list of zones where the group’s permissions apply.
- string
zone_name — The name of the zone or FQDN where the permissions apply.
- string
recurse — Indicates whether or not permissions apply to subnodes of the zone_name .
Valid values:
Y — Permissions apply to zone_name and any nodes below zone_name .
N — Permissions apply only to zone_name .
|
SOAP Syntax
Click to view all SOAP Commands |
UpdatePermissionGroup — Updates data for an existing permissions group.
|
Arguments — Click for More Info
- string
group_name — Required. The name of the permission group to update.
- string
new_group_name — If provided, the new group_name for the permission group.
- string
description — A description of the permission group.
- string
type — The type of the permission group.
Valid values:
plain — A regular permission group.
default — A default permission group. All new users will automatically be added to this group. If user_name isn’t specified, all current users will be added to this group as well.
- string
all_users — If ‘Y’, all current users will be added to the group. Cannot be used if user_name is passed in.
- array
permission — A list of permissions that the group contains.
- array
user_name — A list of users that belong to the permission group.
- array
subgroup — A list of groups that belong to the permission group.
- array
zone — A list of zones where the group’s permissions apply.
- string
zone_name — Required. The name of the zone or FQDN where the permissions apply.
- string
recurse — Indicates whether or not permissions should apply to subnodes of the zone_name .
Valid values:
Y — Permissions apply to zone_name and any nodes below zone_name .
N — Permissions apply only to zone_name .
- string
token — Required. The session identifier.
|
Response — Click for More Info
- hash
data
- string
group_name — The permission group’s name.
- string
description — A description of the permission group.
- string
type — The type of the permission group.
Valid values:
plain — A regular permission group.
default — A default permission group. All new users will automatically be added to this group.
- array
permission — A list of permissions that the group contains.
- array
user_name — A list of users that belong to the permission group.
- array
subgroup — A list of groups that belong to the permission group.
- array
zone — A list of zones where the group’s permissions apply.
- string
zone_name — The name of the zone or FQDN where the permissions apply.
- string
recurse — Indicates whether or not permissions apply to subnodes of the zone_name .
Valid values:
Y — Permissions apply to zone_name and any nodes below zone_name .
N — Permissions apply only to zone_name .
|
Example Request — Click for More Info
{
'token' => 'asdlj34ot879834cdzjklfK',
'group_name' => 'MyGroup',
'new_group_name' => 'MyOldGroup',
'description' => 'This is an example group',
'permission' => [ 'GetUsers', 'GetZones', 'UpdateRecord' ],
'user_name' => [ 'user1', 'user2', 'user3' ],
'subgroup' => [ 'SomeOtherGroup' ],
'zone' => [
{
'zone_name' => 'test.com'
}, {
'zone_name' => 'test2.com',
'recurse' => 'N'
},
],
}
|
DNS API Knowledge Base