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

get Method (group Object)

Description

Show group information. The information displayed includes: group name, ID, scope, description, and principal group members.

Syntax

/api/v1/group/get?group=group&vdc=controller-name 

Arguments

group

Name of the group

vdc

Name of the target virtual data center

Transaction Type

synchronous

Request Type

GET

Examples

Create a local group named mygroup

GET
http://192.168.123.200/api/v1/group/create?group=mygroup&vdc=mygrid

Get group information for group mygroup

GET
http://192.168.123.200/api/v1/group/get?group=mygroup&vdc=mygrid

Sample Output

JSON:

{
   "group" : {
      "members" : {
         "members[2]" : {
            "name" : "*",
            "id" : "f29c1426-10c1-4715-a763-b0bcc4b8b9d5",
            "type" : "user",
            "scope" : "local"
         },
         "members[0]" : {
            "name" : "apimig@3tera.com",
            "id" : "e1a5357f-204b-4cd3-9ca8-9e09f45b21c6",
            "type" : "user",
            "scope" : "local"
         },
         "members[1]" : {
            "name" : "api@3tera.com",
            "id" : "4f865f5b-e63a-410a-9d9a-96427c3ecfc7",
            "type" : "user",
            "scope" : "local"
         },
         "members[3]" : {
            "name" : "apoorva@3tera.com",
            "id" : "b543eff7-db88-4d79-a11c-4de22d5e6d3b",
            "type" : "user",
            "scope" : "local"
         }
      },
      "name" : "mygroup",
      "id" : "a5cb10bc-7291-4a86-84f8-74419fc9ae63",
      "description" : "us",
      "scope" : "local"
   }
}

XML:

[set the product group or family]
  <name>mygroup</name>
  <description>us</description>
  <id>a5cb10bc-7291-4a86-84f8-74419fc9ae63</id>
  <members>
    <name>apimig@3tera.com</name>
    <id>e1a5357f-204b-4cd3-9ca8-9e09f45b21c6</id>
    <scope>local</scope>
    <type>user</type>
  </members>
  <members>
    <name>api@3tera.com</name>
    <id>4f865f5b-e63a-410a-9d9a-96427c3ecfc7</id>
    <scope>local</scope>
    <type>user</type>
  </members>
  <members>
    <name>*</name>
    <id>f29c1426-10c1-4715-a763-b0bcc4b8b9d5</id>
    <scope>local</scope>
    <type>user</type>
  </members>
  <scope>local</scope>
</group>

HTTP Error Codes

400

Entity vdc mygrid not found
- A VDC name was specified that is not configured in the WS_API application.

400.4

Missing required arguments (app).
- Argument group=group missing.

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