API Documentation
Groups CREATE

post

Groups CREATE

Create one or more user groups in the company.
Note: any groups in the input values that match an already existing group (by name) will be ignored. The response will contain only those groups that have been successfully created.
Required Scope: Groups, Create

 

URL Parameters

  • Param Name
    Type
    Description
  • COMPANY_GUID
    string
    Unique ID associated with the company

Resource URL

https://api.syncplicity.com/ provisioning/groups.svc/{COMPANY_GUID}/groups

Header Parameters


Name Values Description
AppKey
(required)

Consumer Key of the app from Developer Portal

Accept
(required)

Accept type of the request

Content-Type
(required)

Content-Type of the request

Body Parameters


Name Values Description
body
(required)

Request Body

HTTP Basic

OAuth 2.0

API Key

Reset

Make a request and see the response.

Make a request and see the response.

Make a request and see the response.

Response Payload Example


		

Response Payload Schema

Response Error Details

  • HTTP Code
    Error Code
    Description
  • 400
    400

    (Bad Request) - Group Array Must Be Set: Request body must contain ArrayOfGroup element
    (Bad Request) - Unknown Group Owner Email Address: Group owner must be an existing user account
    (Bad Request) - Only Company Users Allowed: Group owner must be a member of the company
    (Bad Request) - Unknown Group Set ID: Unknown Id in PolicySet object
    (Bad Request) - Multiple Entity Sets Of One Type Are Not Allowed

  • 403
    403

    (Forbidden) - Not A Business Admin: The user attempting to execute this request is not a company administrator
    (Forbidden) - Not This Company User: The user attempting to execute this request is not a member of the company
    (Forbidden) - StorageVault Feature Is Disabled
    (Forbidden) - Max limit on creation reached

  • 404
    404

    (Not Found) - Wrong Company Id: Company ID must be a Guid
    (Not Found) - Unknown Company Id: A company with the provided ID (Guid) does not exist in Syncplicity

Working...