Data API — Organizations

10 min

organization_create

sync(client: AuthenticatedClient | Client, body: CreateOrganizationRequest | Unset = UNSET) -> OrganizationDetailsResponse | ProblemDetails | list[ErrorResponse] | None

Parameter	Type	Default
client	AuthenticatedClient \| Client	required
body	CreateOrganizationRequest \| Unset	UNSET

body — Information used to create a new organization

Returns: OrganizationDetailsResponse | ProblemDetails | list[ErrorResponse] | None

Raises:

Exception	Condition
UnexpectedStatus	If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
TimeoutException	If the request takes longer than Client.timeout.

organization_delete

sync(id: UUID, client: AuthenticatedClient | Client) -> Any | ProblemDetails | list[ErrorResponse] | None

Parameter	Type	Default
id	UUID	required
client	AuthenticatedClient \| Client	required

Returns: Any | ProblemDetails | list[ErrorResponse] | None

Raises:

Exception	Condition
UnexpectedStatus	If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
TimeoutException	If the request takes longer than Client.timeout.

organization_describe

sync(id: UUID, client: AuthenticatedClient | Client) -> OrganizationDetailsResponse | ProblemDetails | list[ErrorResponse] | None

Parameter	Type	Default
id	UUID	required
client	AuthenticatedClient \| Client	required

Returns: OrganizationDetailsResponse | ProblemDetails | list[ErrorResponse] | None

Raises:

Exception	Condition
UnexpectedStatus	If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
TimeoutException	If the request takes longer than Client.timeout.

organization_list

sync(client: AuthenticatedClient | Client, graph_name: str | Unset = UNSET) -> ProblemDetails | list[ErrorResponse] | list[OrganizationListItemResponse] | None

Parameter	Type	Default
client	AuthenticatedClient \| Client	required
graph_name	str \| Unset	UNSET

Returns: ProblemDetails | list[ErrorResponse] | list[OrganizationListItemResponse] | None

Raises:

Exception	Condition
UnexpectedStatus	If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
TimeoutException	If the request takes longer than Client.timeout.

organization_update

sync(id: UUID, client: AuthenticatedClient | Client, body: UpdateOrganizationRequest | Unset = UNSET) -> OrganizationDetailsResponse | ProblemDetails | list[ErrorResponse] | None

Parameter	Type	Default
id	UUID	required
client	AuthenticatedClient \| Client	required
body	UpdateOrganizationRequest \| Unset	UNSET

body — Request object for updating an organizations information

Returns: OrganizationDetailsResponse | ProblemDetails | list[ErrorResponse] | None

Raises:

Exception	Condition
UnexpectedStatus	If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
TimeoutException	If the request takes longer than Client.timeout.