get_newobj_acl Method (group Object)

Integration Guides › Web Service API Reference Guide › Valid Web API Objects › user Object › get_newobj_acl Method (user Object)

get_newobj_acl Method (user Object)

Description

Display the new object ACL definition associated to a user, or display that portion of the new object ACL definition which relates to a particular principal.

Syntax

/api/v1/user/get_newobj_acl?user=user&principal=principal&vdc=vdc

Arguments

user: Name of the user. Prepend the user name with / to indicate a global user.
principal: A URL-encoded principal
vdc: Name of the target virtual data center

Transaction Type

synchronous

Request Type

GET

Examples

GET http://192.168.123.200/api/v1/user/get_newobj_acl?user=apiuser&principal=&vdc=mygrid

Sample Output

XML:


<acl>
  <entries>
    <name>entries0</name>
    <full>1</full>
    <id>778fee4e-9b83-4160-8b79-8bb0e1a87af8</id>
  </entries>
  <owner>
    <id></id>
  </owner>
</acl>

JSON:


{
   "acl" : {
      "owner" : {
         "id" : ""
      },
      "entries" : {
         "entries0" : {
            "id" : "778fee4e-9b83-4160-8b79-8bb0e1a87af8",
            "full" : 1
         }
      }
   }
}

HTTP Error Codes

404: Entity vdc vdc not found - A VDC name was specified that is not configured in the WS_API application.
404.1: Entity not found - There is no principal name match for 'principal'
400.4: Missing required arguments (user). - Argument user=user missing in the request.

Note: This API is available with WS_API_r10-1.0.10-1 and above.

put Method (user Object)

Description

Replace the entire new object ACL definition associated to a user.

Syntax

/api/v1/user/put_newobj_acl?user=user&acl=<ACLs>&vdc=controller-name

Arguments

user: Name of the user; prepend the user name with / to indicate a global user.
acl: URL-encoded list of principals separated with a slash (/)
principal: A URL-encoded principal
vdc: Name of the target virtual data center

Transaction Type

synchronous

Request Type

GET

Examples


GET
http://192.168.123.200/api/v1/user/put_newobj_acl?user=apiusr&acl=apiusrp%3Downer%2Ftest%403tera.com%3Dconfigure&vdc=mygrid

Sample Output

JSON:


{
   "message" : ""
}

XML:


<message></message>

HTTP Error Codes

400: Entity vdc mygrid not found
- A VDC name was specified that is not configured in the WS_API application.
404.1: Entity not found - There is no principal name match for 'principal'
400.4: Missing required arguments (acl). - Argument acl=<ACL> missing in the request.
400.4: Missing required arguments (user). - Argument user=user missing in the request.

Note: This API is available with WS_API_r6-1.0.6-1 and above.

modify_newobj_acl Method (user Object)

Description

Replace that portion of a new object ACL definition associated to a user which relates to the owner or a principal entry.

Syntax

/api/v1/user/modify_newobj_acl?user=user&acl=<ACLs>&vdc=controller-name

Arguments

user: Name of the user; prepend the user name with / to indicate a global user.
acl: URL-encoded list of principals separated with a slash (/)
vdc: Name of the target virtual data center

Transaction Type

synchronous

Request Type

GET

Examples

GET http://192.168.123.200/api/v1/user/modify_newobj_acl?user=apiusr&acl=apiusr%3Downer%2Ftest%403tera.com%3Dconfigure&vdc=mygrid

Sample Output

XML:


<message></message>

JSON:


{
   "message" : ""
}

HTTP Error Codes

404: Entity vdc controller-name not found - A VDC name was specified that is not configured in the WS_API application.
404.1: Entity not found - There is no principal name match for 'principal'
400.4: Missing required arguments (acl). - Argument acl=<ACL> missing in the request.
400.4: Missing required arguments (user). - Argument user=user missing in the request.

Note: This API is available with WS_API_r10-1.0.10-1 and above.