Retrieving user permissions 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 |
|
UserPermissionReport/ POST — Returns information regarding the requested user’s permission access.
HTTP Action — POST
URI — https://api.dynect.net/REST/UserPermissionReport/
|
| Arguments:
string user_name — The user whose permissions will be returned. Defaults to the current user.
|
Response — Click for More Info
- array
allowed A list of allowed permissions:
- string
name — The name of the permission.
- array
zone — A list of zones where the permission applies.
- string
zone_name — The name of the zone or FQDN where the permission applies.
- string
recurse — Indicates whether or not the permission applies 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.
- array
reason — A list of permission groups containing this permission.
- array
reason — If zone is not defined, a list of permission groups containing this permission.
- array
forbidden — A list of forbidden permissions:
- string
name — The name of the permission.
- array
zone — A list of zones where the permission applies.
- string
zone_name — The name of the zone or FQDN where the permission applies.
- string
recurse — Indicates whether or not the permission applies to subnodes of the zone_name as well.
Valid values:
Y – Permissions apply to zone_name and any nodes below zone_name. Default.
N – Permissions apply only to zone_name.
- array
reason — A list of permission groups containing this permission.
- array
reason — If zone is not defined, a list of permission groups containing this permission.
- string
admin_override — Identifies if the requesting user is an account administrator.
Valid values:
1 — The requesting user is an account administrator.
0 — The requesting user is NOT an account administrator.
|
SOAP Syntax
| Click to view all SOAP Commands |
|
GetUserPermissions — Returns information regarding the requested user’s permission access.
|
Arguments:
- string
token — Required. The session identifier.
- string
user_name — The user whose permissions will be returned. Defaults to the current user.
|
Response — Click for More Info
- hash
data
- array
allowed A list of allowed permissions:
- string
name — The name of the permission.
- array
zone — A list of zones where the permission applies.
- string
zone_name — The name of the zone or FQDN where the permission applies.
- string
recurse — Indicates whether or not the permission applies 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.
- array
reason — A list of permission groups containing this permission.
- array
reason — If zone is not defined, a list of permission groups containing this permission.
- array
forbidden — A list of forbidden permissions:
- string
name — The name of the permission.
- array
zone — A list of zones where the permission applies.
- string
zone_name — The name of the zone or FQDN where the permission applies.
- string
recurse — Indicates whether or not the permission applies to subnodes of the zone_name as well.
Valid values:
Y – Permissions apply to zone_name and any nodes below zone_name.
N – Permissions apply only to zone_name.
- array
reason — A list of permission groups containing this permission.
- array
reason — If zone is not defined, a list of permission groups containing this permission.
- string
admin_override — Identifies if the requesting user is an account administrator.
Valid values:
1 — The requesting user is an account administrator.
0 — The requesting user is NOT an account administrator.
|
Example Request — Click for More Info
{
'user_name' => 'userx',
'token' => 'asdlkfjasl23j4879afa',
}
|
DNS API Knowledge Base
