Develop > Application Programming Interface > Legacy APIs > Artifact API > Add groups to an organization

Add Groups to an Organization

Details

URI /artifact/<organization_id>/group
Method POST
Parameters userIdentifier=<user_id>
    Required; the user ID you want to use as credentials for this API call. See Get userIdentifier for the steps required to get the userIdentifier value.
Returns 200 - Ok
401 - Not authorized
404 - Object not found
500 - Server exception

Note that the role must be specified for each group in the request body. Valid roles are as follows:
For Consumer type organizations:

  • SERVICE_CONSUMER

  • CONSUMER_ORGANIZATION_ADMINISTRATOR

For Provider type organizations:

  • CONSUMER_SERVICE_ADMINISTRATOR
  • CONTENT_MANAGER
  • CSA_ADMIN
  • RESOURCE_SUPPLY_MANAGER
  • SERVICE_BUSINESS_MANAGER
  • SERVICE_DESIGNER
  • SERVICE_OPERATIONS_MANAGER

Example

The following URL was sent:

https://<host>:<port>/csa/rest/artifact/8a81818f3d1421e7013d1423635a0003/group?userIdentifier=90d96588360da0c701360da0f1d5f483

The following XML was sent:


<GroupList>
  <group>
    <displayName>My-Group-Name</displayName>
    <distinguishedName>
      cn=TestConsumer,ou=ConsumerGroup,ou=CSAGroups
    </distinguishedName>
    <role>
      <name>SERVICE_CONSUMER</name>
    </role>
  </group>
  <group>
    <displayName>Another-Group-Name</displayName>
    <distinguishedName>
      cn=TestConsumer2,ou=ConsumerGroup,ou=CSAGroups
    </distinguishedName>
    <role>
      <name>SERVICE_CONSUMER</name>
    </role>
  </group>
 </GroupList>

The following XML was returned:


<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<GroupList>
  <count>2</count>
  <limit>2</limit>
  <group>
    <isCriticalSystemObject>false</isCriticalSystemObject>
    <name>My-Group-Name</name>
    <displayName>My-Group-Name</displayName>
    <disabled>false</disabled>
    <distinguishedName>
      cn=TestConsumer,ou=ConsumerGroup,ou=CSAGroups
    </distinguishedName>
    <role>
      <isCriticalSystemObject>false</isCriticalSystemObject>
      <name>SERVICE_CONSUMER</name>
      <disabled>false</disabled>
    </role>
  </group>
  <group>
    <isCriticalSystemObject>false</isCriticalSystemObject>
    <name>Another-Group-Name</name>
    <displayName>Another-Group-Name</displayName>
    <disabled>false</disabled>
    <distinguishedName>
      cn=TestConsumer2,ou=ConsumerGroup,ou=CSAGroups
    </distinguishedName>
    <role>
      <isCriticalSystemObject>false</isCriticalSystemObject>
      <name>SERVICE_CONSUMER</name>
      <disabled>false</disabled>
    </role>
  </group>
</GroupList>

Send Help Center feedback