Retrieving Permission Group information using 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/ GET — Retrieves information on permission groups.
HTTP Action — GET
URIs:
Get one Permission Group — https://api.dynect.net/REST/PermissionGroup/<group_name>/
Get Permissions Groups — https://api2.dynect.net/REST/PermissionGroup/
NOTE: If no group_name is specified, a list of available permission groups will be returned.
Otherwise, the information specific to the given permission group will be returned.
|
| Arguments:
No Arguments.
|
| Response:
Get one Permission Group — 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 as well.
Valid values:
Y — Permissions apply to zone_name and any nodes below zone_name
N — Permissions only apply to zone_name
Get Permissions Groups — array of Individual Permission Group resources.
|
SOAP Syntax
| Click to view all SOAP Commands |
|
GetOnePermissionGroup — Retrieves information about the specified permission group.
GetPermissionGroups — Retrieves information about all permission groups.
|
Arguments — Click for More Info
For Retrieving One Permission Group:
string group_name — Required. The permission group’s name.
string token — Required. The session identifier.
For Retrieving A List of All Permission Groups:
string token — Required. The session identifier.
|
| Response:
GetOnePermissionGroup — 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 as well.
Valid values:
Y – Permissions apply to zone_name and any nodes below zone_name
N – Permissions only apply to zone_name
GetPermissionGroups — Click for More Info
- array
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 as well.
Valid values:
Y – Permissions apply to zone_name and any nodes below zone_name
N – Permissions only apply to zone_name
|
Example Request (GetOnePermissionGroup) — Click for More Info
{
'group_name'=>'MyGroup',
'token'=> 'zaq12wsxcDe34rf89gt56nh',
}
|
Example Request (GetPermissionGroups) — Click for More Info
{
'token'=> 'zaq12wsxcDe34rf89gt56nh',
}
|
DNS API Knowledge Base
