Orgs¶

class _incydr_sdk.orgs.client.OrgsV1(parent)

Client for /v1/orgs endpoints.

Usage example:

>>> import incydr
>>>
>>> client = incydr.Client(**kwargs)
>>> client.orgs.v1.list_orgs()

activate(self, org_guid)

Activate an org.

Parameters:

Returns: A requests.Response indicating success.

create(self, org_name, org_ext_ref=None, parent_org_guid=None, notes=None)

Create an org.

Parameters:

org_name: str (required) - The name of the org to create.
org_ext_ref: str - The external reference of the org to create. Defaults to None.
parent_org_guid: str - The parent ID of the org to create. Defaults to None.
notes: str - The notes of the org to create. Defaults to None. pa Returns: An [Org][org-model] object representing the created org.

deactivate(self, org_guid)

Deactivate an org.

Parameters:

Returns: A requests.Response indicating success.

get_org(self, org_guid)

Get a specific organization.

Parameters:

Returns: An [Org][org-model] object representing the org.

list(self, active=None)

List orgs.

Parameters:

active: bool - Return only orgs matching this active state. Defaults to None, which will return both active and inactive orgs.

Returns: An [OrgsList][orgslist-model] object.

update(self, org_guid, org_name, org_ext_ref=None, notes=None)

Update an org.

Parameters:

org_guid: str (required) - The unique ID for the org to update.
org_name: str (required) - The name of the org to update.
org_ext_ref: str - The external reference of the org to update. Defaults to None.
notes: str - The notes of the org to update. Defaults to None.

Returns: An [Org][org-model] object representing the created org.