Bulk create groups

POST

/scim/v2/Groups/bulk

POST

/scim/v2/Groups/bulk

from zuora import ZuoraClient
from zuora.scim import PostBulkCreateGroupsRequestItem, PostBulkCreateGroupsRequestItemUrnZuoraScimSchemas10GroupExtension, PostBulkCreateGroupsRequestItemMeta
client = ZuoraClient(
    token="YOUR_TOKEN_HERE",
)
client.scim.post_bulk_create_groups(
    request=[
        PostBulkCreateGroupsRequestItem(
            schemas=[
                "urn:ietf:params:scim:schemas:core:2.0:Group",
                "urn:zuora:scim:schemas:1.0:GroupExtension"
            ],
            display_name="test_group_11",
            urn_zuora_scim_schemas10group_extension=PostBulkCreateGroupsRequestItemUrnZuoraScimSchemas10GroupExtension(
                schemas=[
                    "urn:zuora:scim:schemas:1.0:GroupExtension"
                ],
                description="",
                organization_id="ec141dc2-901e-4813-a25d-ef480cff1e26",
                active=False,
            ),
            meta=PostBulkCreateGroupsRequestItemMeta(
                resource_type="Group",
            ),
        ),
        PostBulkCreateGroupsRequestItem(
            schemas=[
                "urn:ietf:params:scim:schemas:core:2.0:Group",
                "urn:zuora:scim:schemas:1.0:GroupExtension"
            ],
            display_name="test_group_22",
            urn_zuora_scim_schemas10group_extension=PostBulkCreateGroupsRequestItemUrnZuoraScimSchemas10GroupExtension(
                schemas=[
                    "urn:zuora:scim:schemas:1.0:GroupExtension"
                ],
                description="",
                organization_id="ec141dc2-901e-4813-a25d-ef480cff1e26",
                active=False,
            ),
            meta=PostBulkCreateGroupsRequestItemMeta(
                resource_type="Group",
            ),
        )
    ],
)

{
  "schemas": [
    "urn:ietf:params:scim:api:messages:2.0:ListResponse"
  ],
  "totalResults": 2,
  "id": null,
  "externalId": null,
  "meta": null,
  "resources": [
    {
      "schemas": [
        "urn:ietf:params:scim:schemas:core:2.0:Group",
        "urn:zuora:scim:schemas:1.0:GroupExtension"
      ],
      "id": "62c20400-6470-4992-8a01-c181efc2ce54",
      "displayName": "test_group_11",
      "urn:zuora:scim:schemas:1.0:GroupExtension": {
        "schemas": [
          "urn:zuora:scim:schemas:1.0:GroupExtension"
        ],
        "description": "",
        "organizationId": "5619df2e-fa8c-47fa-9c1e-16ab5af4936e",
        "active": true
      },
      "meta": {
        "resourceType": "Group",
        "location": "http://localhost:9900/scim/v2/Groups/bulk/62c20400-6470-4992-8a01-c181efc2ce54"
      }
    },
    {
      "schemas": [
        "urn:ietf:params:scim:schemas:core:2.0:Group",
        "urn:zuora:scim:schemas:1.0:GroupExtension"
      ],
      "id": "71d3c0ec-48db-4522-b5c9-053e051204d7",
      "displayName": "test_group_22",
      "urn:zuora:scim:schemas:1.0:GroupExtension": {
        "schemas": [
          "urn:zuora:scim:schemas:1.0:GroupExtension"
        ],
        "description": "",
        "organizationId": "5619df2e-fa8c-47fa-9c1e-16ab5af4936e",
        "active": true
      },
      "meta": {
        "resourceType": "Group",
        "location": "http://localhost:9900/scim/v2/Groups/bulk/71d3c0ec-48db-4522-b5c9-053e051204d7"
      }
    }
  ],
  "startIndex": 1,
  "itemsPerPage": 2
}

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.

Authentication

AuthorizationBearer

Use Bearer {{token}} in the Authorization header for authentication.

Request

This endpoint expects a list of objects.

schemaslist of stringsRequired

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

displayNamestringRequired

Name of the group.

urn:zuora:scim:schemas:1.0:GroupExtensionobjectRequired

Custom extension schema with additional attributes for the group.

metaobject or nullRequired

Metadata about the group resource.

Response headers

Content-EncodingstringOptional

RateLimit-LimitstringOptional

RateLimit-Remaininginteger

RateLimit-Resetinteger

Zuora-Request-IdstringOptional

Zuora-Track-IdstringOptional

Response

schemaslist of stringsOptional

List of schema URNs defining the structure of the response.

totalResultsintegerOptional

Total number of user groups returned in the response.

idstring or nullOptional

externalIdstring or nullOptional

metastring or nullOptional

resourceslist of objectsOptional

List of group resources returned by the query.

startIndexintegerOptional

itemsPerPageintegerOptional

Errors

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error