Develop > API calls > Artifact APIs > Update group display name or distinguished name

Update group display name or distinguished name

Updates the group display name or distinguished name for the specified organization.

URI Method Parameters Returns
http://[host]:[port]/csa/rest/artifact/{organizationID}/group/{groupID} PUT
  • Organization ID
  • User ID -     Required; the user ID you want to use as credentials for this API call.

200 - successful
401 - not authorized
404 - object not found
505 - server exception

Example

The following URL was sent:

https://localhost:8444/csa/rest/artifact/8a81818f3d02fb7e013d0308891d0003/group/8a81818f3d1437e2013d1795d41107ea?userIdentifier=90d96588360da0c701360da0f1d5f483

The following XML was sent:

<GroupList>
  <group>
    <displayName>My-New-Group-Name</displayName>
    <distinguishedName>
      cn=TestConsumer,ou=CodarApplicationDeveloper,ou=CodarGroups
    </distinguishedName>
  </group>
</GroupList>

The following XML was returned:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Group>
 <id>8a81818f3d1437e2013d1795d41107ea</id>
  <isCriticalSystemObject>false</isCriticalSystemObject>
  <name>sc_February 22, 2013 5:54:43 PM UTC</name>
 <displayName>My-New-Group-Name</displayName>
 <state>
    <id>90d96588360da0c701360da0ef470038</id>
    <isCriticalSystemObject>false</isCriticalSystemObject>
    <name>ACTIVE</name>
    <disabled>false</disabled>
  </state>
 <artifactType>
    <id>90d96588360da0c701360da0eeff002b</id>
    <isCriticalSystemObject>false</isCriticalSystemObject>
    <name>GROUP</name>
    <disabled>false</disabled>
  </artifactType>
  <disabled>false</disabled>
  <distinguishedName>
     cn=TestConsumer,ou=CodarApplicationDeveloper,ou=CodarGroups
  </distinguishedName>
 </Group>