GroupProfile

Group Profile resource for Authentication Service.

Resource operations

This resource supports the following standard methods: create(), load(), update(), delete(). They operate on the instance state — set properties with dot notation, then call the method with no arguments. Any other action listed below is a custom action that takes explicit keyword arguments and returns a value.

Quick Start

import zssdk
import logging

# Enable debug logging for GroupProfile
logging.getLogger('zssdk.zid').setLevel(logging.DEBUG)
logging.basicConfig(level=logging.DEBUG)

session = zssdk.Session(
    vanity_domain="your-vanity-domain",
    client_id="your-client-id",
    client_secret="your-client-secret",
)

# Get a specific GroupProfile
resource = session.zid.GroupProfile(id="your-resource-id")
resource.load()
print(resource)

# Debug output shows HTTP request/response details

Identifiers

Name	Type	Description
id	string	Unique identifier

Actions

add_group_user()

Parameters:

Name	Type	Required	Description
user_id	string	Yes	-

Example:

resource = session.zid.GroupProfile(id="your-resource-id")
result = resource.add_group_user(user_id="resource-id")
print(result)

add_group_users()

Parameters:

Name	Type	Required	Description
users	RefPubReqCollection	Yes	-

Example:

resource = session.zid.GroupProfile(id="your-resource-id")
result = resource.add_group_users(users=[{"id": "resource-id"}])
print(result)

bulkdelete()

bulkdelete operation is all or none operation, if any group is not eligible for deletion, none of the groups will be deleted

Parameters:

Name	Type	Required	Description
groups	RefPubReqCollection	Yes	-

Example:

resource = session.zid.GroupProfile()
result = resource.bulkdelete(groups=[{"id": "resource-id"}])
print(result)

bulkremove()

Parameters:

Name	Type	Required	Description
users	RefPubReqCollection	Yes	-

Example:

resource = session.zid.GroupProfile(id="your-resource-id")
result = resource.bulkremove(users=[{"id": "resource-id"}])
print(result)

create()

Creates a new GroupProfile. Set properties on the resource instance, then call create() — this method takes no arguments.

Properties for creation:

Name	Type	Required	Description
name	string	Yes	-
description	string	No	-
source	string	Yes	-
idp	RefPubResp	No	-
dynamic_group	boolean	Yes	-
admin_entitlement_enabled	boolean	Yes	-
service_entitlement_enabled	boolean	Yes	-

Returns: GroupProfile

Example:

resource = session.zid.GroupProfile()
resource.name = "example-name"
resource.source = "value"
resource.dynamic_group = True
resource.admin_entitlement_enabled = True
resource.service_entitlement_enabled = True
resource.create()
print(f"Created with ID: {resource.id}")

delete()

Deletes a GroupProfile by id. Only the id identifier is required; delete() takes no other arguments.

Example:

resource = session.zid.GroupProfile(id="your-resource-id")
resource.delete()

load()

Fetches an existing GroupProfile by id. Only the id identifier is required; load() takes no other arguments.

Returns: GroupProfile

Example:

resource = session.zid.GroupProfile(id="your-resource-id")
resource.load()
print(resource.name)

remove_group_user()

Parameters:

Name	Type	Required	Description
user_id	string	Yes	-

Example:

resource = session.zid.GroupProfile(id="your-resource-id")
result = resource.remove_group_user(user_id="resource-id")
print(result)

replace_group_users()

Parameters:

Name	Type	Required	Description
users	RefPubReqCollection	Yes	-

Example:

resource = session.zid.GroupProfile(id="your-resource-id")
result = resource.replace_group_users(users=[{"id": "resource-id"}])
print(result)

update()

Updates an existing GroupProfile. Call load() first, modify properties, then call update() — this method takes no arguments.

Properties for update:

Name	Type	Required	Description
name	string	Yes	-
description	string	No	-
source	string	Yes	-
idp	RefPubResp	No	-
dynamic_group	boolean	Yes	-
admin_entitlement_enabled	boolean	Yes	-
service_entitlement_enabled	boolean	Yes	-

Returns: GroupProfile

Example:

resource = session.zid.GroupProfile(id="your-resource-id")
resource.load()
resource.name = "Updated value"
resource.update()

Attributes

Name	Type	Required	Description
name	string	Yes	-
description	string	No	-
id	string	Yes	-
source	string	Yes	-
idp	RefPubResp	No	-
dynamic_group	boolean	Yes	-
admin_entitlement_enabled	boolean	Yes	-
service_entitlement_enabled	boolean	Yes	-

Related

• GroupProfile - Data structure definition
• Logging guide - enable verbose logs while debugging this resource