Bulk create groups

Creates multiple Groups within an organization.

Must include the displayName attribute. Users can be added to the group during creation by supplying the user ID values in the members array attribute.

Example request body:

[
  {
    "schemas": [
      "urn:ietf:params:scim:schemas:core:2.0:Group",
      "urn:zuora:scim:schemas:1.0:GroupExtension"
    ],
    "displayName": "test_group_1",
    "urn:zuora:scim:schemas:1.0:GroupExtension": {
      "schemas": [
        "urn:zuora:scim:schemas:1.0:GroupExtension"
      ],
      "description": "",
      "organizationId": "ec141dc2-901e-4813-a25d-ef480cff1e26",
      "active": false
    },
    "meta": {
      "resourceType": "Group"
    }
  },
  {
    "schemas": [
      "urn:ietf:params:scim:schemas:core:2.0:Group",
      "urn:zuora:scim:schemas:1.0:GroupExtension"
    ],
    "displayName": "test_group_2",
    "urn:zuora:scim:schemas:1.0:GroupExtension": {
      "schemas": [
        "urn:zuora:scim:schemas:1.0:GroupExtension"
      ],
      "description": "",
      "organizationId": "ec141dc2-901e-4813-a25d-ef480cff1e26",
      "active": false
    },
    "meta": {
      "resourceType": "Group"
    }
  }
]
Request
Request Body schema: application/json
required
Array
schemas
required
Array of strings

List of schema URNs defining the structure of the group resource.

displayName
required
string

Name of the group.

required
object

Custom extension schema with additional attributes for the group.

required
object

Metadata about the group resource.

Responses
200

OK

201

Created

401

Unauthorized

403

Forbidden

404

Not Found

post/scim/v2/Group/bulk
Request samples
application/json
[
  • {
    }
]
Response samples
application/json
{
  • "schemas": [
    ],
  • "totalResults": 2,
  • "Resources": [
    ]
}