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

get_newobj_acl Method (group Object)

Description

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

Syntax

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

Arguments

group

Name of the group. Prepend the group name with / to indicate a global group.

principal

Name of the principal. <principal> is in the form:

URL

Encoded principal in the form:

<name> - Local user or group.

/<name> - Global user or group.

<scope>:<type>:<name> - A fully qualified principal name where <scope> is 'global' or 'local', <type> is 'group' or 'user' and <name> is the group or user name.

For example, local:user:api@3tera.com=full should be passed as local%3Auser%3Aapi%403tera.com%3Dfull

If principal is an empty string, then the full new object ACL definition associated to a group is displayed; Otherwise, only the portion of the new object ACL definition which relates to a particular principal is displayed.

vdc

Name of the target virtual data center

Transaction Type

synchronous

Request Type

GET

Examples

GET http://192.168.123.200/api/v1/group/get_newobj_acl?group=apigroup&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 (group). - Argument group=group missing in the request.

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

put_newobj_acl Method (group Object)

Description

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

Syntax

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

Arguments

group

Name of the group; prepend the group name with / to indicate a global group.

acl

URL-encoded ' / ' separated list of principals.

The principal for the owner must be a group.

For example, local:group:apigroup=full should be passed as local%3Agroup%3Aapigroup%3Dfull

For example, local:group:apigroup=full/local:user:test@3tera.com=configure should be passed as local%3Agroup%3Aapigroup%3Dfull%2Flocal%3Auser%3Atest%403tera.com%3Dconfigure

vdc

Name of the target virtual data center

Transaction Type

synchronous

Request Type

GET

Examples

GET http://192.168.123.200/api/v1/group/put_newobj_acl?group=apigroup&acl=apigroup%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 (group). - Argument group=group missing in the request.

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

modify_newobj_acl Method (group Object)

Description

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

Syntax

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

Arguments

group

Name of the group; prepend the group name with / to indicate a global group.

acl

URL-encoded ' / ' separated list of principals.

The principal for the owner must be a group.

For example, local:group:apigroup=full should be passed as local%3Agroup%3Aapigroup%3Dfull

For example, local:group:apigroup=full/local:user:test@3tera.com=configure should be passed as local%3Agroup%3Aapigroup%3Dfull%2Flocal%3Auser%3Atest%403tera.com%3Dconfigure

vdc

Name of the target virtual data center

Transaction Type

synchronous

Request Type

GET

Examples

GET http://192.168.123.200/api/v1/group/modify_newobj_acl?group=apigroup&acl=apigroup%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 (group). - Argument group=group missing in the request.

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