REST API - POST User Group Properties

userGroupId

The user group ID for the user group. If the user group ID is not known, use the GET User Group API to retrieve it.

Yes-for the request by ID

userGroupName

The user group name of the user group. If the user group name is not known, use the GET User Group API to retrieve it.

Yes-for the request by name

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.

userGroupName

The name of the user group.

userGroupEntity

newName

If you are changing the name of the user group, enter the new name in the <newName> element and the original name in the <userGroupName> element.

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>
      
  

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:

categoriesPermissionList

usersOperationType

The operation to perform on the users in the userName parameter in the <users> element. Valid values are:

• ADD, to associate new users.

• OVERWRITE, to overwrite the existing users with the new users.

• DELETE, to delete one or more users.

groups

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 to associate 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

isBlackListed

The option to block laptop activation for the user group.

groups

errorCode

The possible error codes.

Valid values are:

• 0, successful completion.

• 2, a failure.

• a specific error code.

response

errorString

The description of the error code. Not all error codes have an error string.

response