Loading...

REST API - POST User Group

This operation creates a user group.

Request

Syntax

POST <webservice>/UserGroup HTTP/1.1
Host: <host name>
Accept: application/xml
Authtoken: <authentication token>
Content-type: application/xml

<create_usergroup_template.xml>

where <webservice> is the root path used to route the API requests to the Web Server.

For more information, see Available Web Services for REST API.

Request Header

Name

Description

Host

The host name of the Web Server or Web Console used in the API request.

Accept

The format of the response. Valid values are: application/xml or application/json.

Authtoken

The authentication token received after successfully logging on. For details on receiving an authentication token, see Authentication.

Content-type

The media type contained in the request body.

Request Body

Download the create_usergroup_template.xml file required for this request. The following table displays the parameters for the create_usergroup_template.xml file.

Parameter

Description

Element

userGroupName

The name of the user group.

userGroupEntity

associationsOperationType

The operation to perform on the role and entities inside the <associations> block. The entity, role, and user group form a security association. To perform an operation on multiple security associations, add an <associations> block in the XML file for each security association:

<associations>
<entities>
<entity>
<entity_name></entity_name>
</entity>
</entities>
<properties>
<role>
<roleName></roleName>
</role>
</properties>
</associations>

Valid values are:

  • ADD, to create a new security association between the entity, role, and user group
  • OVERWRITE, to overwrite existing security associations with new security associations
  • DELETE, to delete one or more security associations

securityAssociations

entity_name

Replace entity_name with the name of the entity operated on by the associationsOperationType parameter.

Valid replacement values are:

  • appName
  • backupsetName
  • clientGroupName
  • clientName
  • commCellName
  • containerName
  • libraryName
  • locationName
  • mediaAgentName
  • providerDomainName
  • schedulePolicyName
  • shelfName
  • storagePolicyName
  • subclientName
  • trackingPolicyName
  • userGroupName
  • userName

    To include multiple entities in a security association, add the following elements in the XML file for each entity:

    <entity>
    <entity_name>entity_value</entity_name>
    </entity>

    Examples

    To associate two libraries, enter the following in the XML file:

    <entities>
    <entity>
    <libraryName>library_001</libraryName>
    </entity>
    <entity>
    <libraryName>library_022</libraryName>
    </entity>
    </entities>

    To associate a domain, enter the following in the XML file:

    <entities>
    <entity>
    <providerDomainName>mydomain</providerDomainName>
    </entity>
    </entities>

    To associate a file system and a MySQL agent, enter the following in the XML file:

    <entities>
    <entity>
    <appName>File System</appName>
    </entity>
    </entities>
    <entities>
    <entity>
    <appName>MySQL</appName>
    </entity>
    </entities>

Tip: For a list of valid values for the <appName> element, see GET Agent: appName.

entity

roleName

The name of the role operated on by the associationsOperationType parameter. The <associations> block must have exactly one role, for example:

<associations>
<properties>
<role>
<roleName>Role3</roleName>
</role>
</properties>
...
...
</associations>

role

permissionName

Use this element to add permissions without selecting a role. If you use the permissionName parameter, you cannot use the roleName parameter.

The name of the permission operated on by the associationsOperationType parameter. To work with multiple permissions, add the following elements in the XML file for each permission:

<categoriesPermissionList permissionName = ""/>

For a list of valid values, see User Security Permissions and Permitted Actions.

categoriesPermissionList

categoryName

Use this element to add all of the permissions in a category without selecting a role. If you use the categoryName parameter, you cannot use the roleName parameter.

The name of the permission category operated on by the associationsOperationType parameter. To work with multiple categories, add the following elements in the XML file for each category:

<categoriesPermissionList categoryName = ""/>

Valid values are:

Access Policies

Features

Alert

Global

Analytics

Monitoring Policy

Billing

Plan

Client

Schedule Policy

Client Group

Storage Management

CommCell

Storage Provisioning

Content Director

Subclient Policy

Custom Property

User Management

Developer Tools

VM Operations

 

categoriesPermissionList

enabled

The option to enable/disable the user group.

Valid values are True/False.

groups

description

A general description of the user group.

groups

userName

The name of the user associated with the user group. To associate more than one user with a user group, add a <users> element for each user:

<users>
   <userName>USER1</userName>
</users>
<users>
   <userName>USER2</userName>
</users>

users

Response

Response Parameters

Parameter

Description

Element

errorCode

The possible error codes.

Valid values are:

  • 0, successful completion.
  • 2, a failure.
  • a specific error code.

response

Examples

Sample Request

POST <webservice>/UserGroup HTTP/1.1
Host: client.mydomain.com
Accept: application/xml
Authtoken: QSDK 38568012f4d1e8ee1841d283a47aa3ba78e124ea58354b5fc6
0f4dab8a63347d05cf5552484dafda3bfa4c5db84e580b1cb37bcf8e65b39f7f
8549a443e6f78a2c7be3f31b3d845e24776c835e498e8e883bb40c46bd15af4f
40ca94e823acedcdd4e9659e74b34a07a85c4586cd2ed914b6dce015874783ef7
68fda78183a4208930954a377f66eb56c8b92cexampl4s437a19317ca6ce7f323
3d5a01aca35dbad93468b833f2cf71010809006a937670adce711ca8be46638e8
Content-type: application/xml

<App_CreateUserGroupRequest>
  <groups>
    <userGroupEntity>
      <userGroupName>Alerts</userGroupName>
    </userGroupEntity>
 <securityAssociations>
  <associationsOperationType>ADD</associationsOperationType>
  <associations>
   <entities>
    <entity>
      <clientName>client001</clientName>
    </entity>
    <entity>
      <clientName>client022</clientName>
    </entity>
   </entities>
   <properties>
    <role>
     <roleName>Limited</roleName>
    </role>
   </properties>
  </associations>
 </securityAssociations>
    <enabled>true</enabled>
    <description>access to alerts only</description>
    <users>
      <userName>jdoe</userName>
    </users>
  </groups>
</App_CreateUserGroupRequest>

Sample Response

<App_CreateUserGroupResponse>
  <response errorCode="0"/>
</App_CreateUserGroupResponse>

Last modified: 4/27/2020 7:20:36 PM