POST - Group Admin

Builds a group-level administrator.

Parameters

  • service_provider_id (str): Service provider ID where the admin should be built.

  • group_id (str): Group ID where the admin should be built

  • user_id (str): User Id of the admin.

  • password (str): Password for the administrator profile. Note get.password_generate() can be used to get this.

  • payload (dict, optional): Admin configuration data.

Returns

  • Dict: Returns the admin profile.

How To Use:

my_api.administrators.post_group_admin(
    "my_service_provider_id",
    "my_group_id",
    "[email protected]", 
    "password123"
)

Example Data Returned (Formatted)

{
    "userId": "[email protected]", 
    "serviceProviderId": "my_service_provider_id", 
    "groupId": "my_group_id", 
    "language": "English", 
    "locale": "en_US", 
    "encoding": "ISO-8859-1"
}

Last updated

Was this helpful?