admin module

rohub.admin.admin.delete_community(community_identifier)

Function that deletes a specific community based on its identifier.

Warning

The operation is permitted only if you are logged into account with admin privileges

Parameters

community_identifier – community identifier

Rtype identifier

str

Returns

response content from the API

Return type

dict

rohub.admin.admin.delete_custom_license(license_id)

Function that deletes selectec custom license.

Parameters

license_id – license identifier

Type

license_id: str

Returns

None

Return type

None

rohub.admin.admin.delete_external_user(user_identifier)

Function that deletes specific external user.

Warning

The operation is permitted only if you are logged into account with admin privileges

Parameters

user_identifier (str) – user’s identifier

Returns

response/None

Return type

dict/None

rohub.admin.admin.delete_organization(organization_identifier)

Function that deletes specific organization.

Warning

The operation is permitted only if you are logged into account with admin privileges

Parameters

organization_identifier (str) – user’s identifier

Returns

response/None

Return type

dict/None

rohub.admin.admin.update_community(identifier, name=None, description=None, email=None, community_url=None)

Function that updates a specific community.

Parameters
  • identifier (str) – communities identifier

  • name (str) – community name, optional

  • description (str) – community description, optional

  • email – communities email, optional

  • community_url – associated url, optional

Type

email: str

Type

community_url: str

Returns

response content from the API

Return type

dict

rohub.admin.admin.update_custom_license(identifier, title, status, license_url, description=None)

Function that updates a custom license.

Parameters
  • identifier (str) – license’s identifier

  • title (str) – license’s title

  • status (str) – license’s status

  • license_url (str) – license’s url

  • description (str) – license’s description, optional

Returns

response content from the API

Return type

dict