Organization

organization.organization.add_admins(organization_id, members)

Add list of members to organizatioin admin list

Parameters
  • organization_id (str) – Unique organization identifier

  • members (list) – List of unique member identifiers

Returns

None

organization.organization.admins(organization_id)

Provides list of the organization admin members

Parameters

organization_id (str) – Unique organization identifier

Returns

None

organization.organization.copy(organization_id, rollup_id, after_position)

Copies an organization

Parameters
  • organization_id (str) – Unique organization identifier

  • rollup_id (str) – Unique rollup identifier

  • after_position (int) – Position within the object rollup the object should be placed after

Returns

None

organization.organization.create(rollup_id, name, memo, tax_id=None)

Creates an organization

Parameters
  • rollup_id (str) – Unique rollup identifier

  • name (str) – The object name

  • memo (str) – The object description

  • tax_id (str, optional) – Tax ID for organization

Returns

None

organization.organization.create_rollup(organization_id, rollup_id, position, name)

Creates a folder in the organization hierarchy

Parameters
  • organization_id (str) – Unique organization identifier

  • rollup_id (str) – Unique rollup identifier

  • position (int) – The position order of the object within the rollup

  • name (str) – The object name

Returns

None

organization.organization.delete(organization_id)

Deletes an organization and all associated workspaces

Parameters

organization_id (str) – Unique organization identifier

Returns

None

organization.organization.delete_rollup(organization_id, rollup_id)

Deletes a folder and its contents in the organization hierarchy

Parameters
  • organization_id (str) – Unique organization identifier

  • rollup_id (str) – Unique rollup identifier

Returns

None

organization.organization.id_from_path(path)

Provides the cannonical id for the from a provided path

Parameters

path (str) – Object rollup path using unix style forward slashes

Returns

None

organization.organization.make_rollups(organization_id, path)

Creates the path and all intermediate rollup points

Parameters
  • organization_id (str) – Unique organization identifier

  • path (str) – Object rollup path using unix style forward slashes

Returns

None

organization.organization.move(organization_id, rollup_id, after_position)

Moves a organization in the hierarchy

Parameters
  • organization_id (str) – Unique organization identifier

  • rollup_id (str) – Unique rollup identifier

  • after_position (int) – Position within the object rollup the object should be placed after

Returns

None

organization.organization.organization(organization_id)

Provides detailed information about the organization

Parameters

organization_id (str) – Unique organization identifier

Returns

None

organization.organization.organizations(id_filter=None)

Provides list of organizations

Parameters

id_filter (list) – List or tuple of object unique identifiers to which to limit the results

Returns

None

organization.organization.organizations_from_labels(labels)

Provides list of organizations for based on set of labels. Uses AND condition.

Parameters

labels (list) – List or tuple of label unique names

Returns

None

organization.organization.organizations_from_path(path)

Provides list of organizations based on a path fragment. Path fragment can be to parent level.

Parameters

path (str) – Object rollup path using unix style forward slashes

Returns

None

organization.organization.paths_from_id(organization_id)

Provides a list of paths associated with the cannonical id

Parameters

organization_id (str) – Unique organization identifier

Returns

None

organization.organization.remove_admins(organization_id, members)

Removes list of members from the admin list

Parameters
  • organization_id (str) – Unique organization identifier

  • members (list) – List of unique member identifiers to remove

Returns

None

organization.organization.set_member_expiration(organizatioin_id, expire_days)

Sets the expiration of member accounts in days. 0 means does not expire automatically.

Parameters
  • organization_id (str) – Unique organization identifier

  • expire_days (int) – Days until member account expires if no login occurs

Returns

None

organization.organization.set_sso_group_assignment(organization_id, allow_group_assignment)

Activates ability for the SAML exchange to pass in groups for which the member will be assigned

Parameters
  • organization_id (str) – Unique organization identifier

  • allow_group_assignment (bool) – If True, allows passing in security groups with SAML exchange

Returns

None

organization.organization.set_sso_required(organization_id, sso_required)

Sets the organization to require SAML2 single sign-on access only

Parameters
  • organization_id (str) – Unique organization identifier

  • sso_required (bool) – If True, organization access is limited to SSO sign-ins only

Returns

None

organization.organization.update(organization_id, **kwargs)

Updates an organization information

Parameters

organization_id (str) – Unique organization identifier

Kwargs:
  • name (str): The object name

  • memo (str): The object description

  • tax_id (str): Tax ID for organization

Returns

None

organization.organization.update_rollup(organization_id, **kwargs)

Updates a folder name in the organization hierarchy

Parameters

organization_id (str) – Unique organization identifier

Kwargs:
  • rollup_id (str): Unique rollup identifier

  • position (int): The position order of the object within the rollup

  • name (str): The object name

Returns

None