List Policies | RESTful API | Teradata Data Mover - 17.11 - List Policies (RESTful API) - Teradata Data Mover

Teradata® Data Mover User Guide

Product
Teradata Data Mover
Release Number
17.11
Release Date
October 2021
Content Type
User Guide
Publication ID
B035-4101-091K
Language
English (United States)

Overview

List the policies on jobs, daemon advanced settings, and daemon access using the following URL and method:
Item Description
URL /datamover/policies
Method GET
When security is enabled, only a Viewpoint or command line admin can retrieve daemon advanced and daemon access policy types. Non-admin users can only check policies on a specific job.

Request Header

Authorization
Description: Basic header authentication
User must be dmcl_admin if call is from Viewpoint.
JSON Data Type: String
Required: No, unless securityMgmt is enabled
Portlet-User
Description: Viewpoint user login
JSON Data Type: String
Required: No, unless call is made from Viewpoint
Portlet-Roles
Description: Roles associated with Viewpoint user login
JSON Data Type: String, separated by commas when more than one role exists
Required: No, unless call is made from Viewpoint

Request Parameters

resource_type
Description: The type of resource associated with the policy. Valid values are:
  • tdrn:datamover:daemon_access
  • tdrn:datamover:daemon_advanced
  • tdrn:datamover:job
JSON Data Type: String
Required: Yes
resource_name
Description: The resource name associated with the policy.
JSON Data Type: String
Required: No, unless resource_type is tdrn:datamover:job

Response Parameters

No response parameters required.

Examples

The following is a request example to list policies for daemon access:
/datamover/policies?resource_type=tdrn:datamover:daemon_access
The following example is of a successful response for daemon access policies:
[ { "service" : "datamover", "type" : "user", "principals" : [ "dn186008" ], "actions" : [ "read", "write", "execute" ], "resources" : [ "tdrn:datamover:daemon_access:*" ] },
{ "service" : "datamover", "type" : "role", "principals" : [ "Administrator" ], "actions" : [ "read", "write", "execute" ], "resources" : [ "tdrn:datamover:daemon_access:*" ] },
{ "service" : "datamover", "type" : "user", "principals" : [ "tester_002" ], "actions" : [ "read", "write" ], "resources" : [ "tdrn:datamover:daemon_access:*" ] },
{ "service" : "datamover", "type" : "role", "principals" : [ "User" ], "actions" : [ "read" ], "resources" : [ "tdrn:datamover:daemon_access:*" ] },
{ "service" : "datamover", "type" : "user", "principals" : [ "abcd" ], "actions" : [ "read", "write", "execute" ], "resources" : [ "tdrn:datamover:daemon_access:*" ] },
{ "service" : "datamover", "type" : "user", "principals" : [ "admin" ], "actions" : [ "read", "write", "execute" ], "resources" : [ "tdrn:datamover:daemon_access:*" ] },
{ "service" : "datamover", "type" : "user", "principals" : [ "tester_001" ], "actions" : [ "read" ], "resources" : [ "tdrn:datamover:daemon_access:*" ] },
{ "service" : "datamover", "type" : "user", "principals" : [ "test_002" ], "actions" : [ "write" ], "resources" : [ "tdrn:datamover:daemon_access:*" ] } ]
The following example is of a failed response code when the user does not have permissions to retrieve policies:
{ "message" : "When security is on, only commandline super user or viewpoint could retrieve policies for resource type.tdrn:datamover:daemon_access.The user does not have the permission to run GET_GLOBAL_ACCESS_PERMISSIONS command" }