Platform — API Keys v1

12 min

api_key_create

sync(client: AuthenticatedClient | Client, body: ApiKeyCreateApiModel | Unset = UNSET) -> Any | ApiKeyCreatedApiModel | None

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

Returns: Any | ApiKeyCreatedApiModel | 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.

api_key_delete

sync_detailed(id: UUID, client: AuthenticatedClient | Client) -> Response[Any]

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

Returns: Response[Any]

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.

api_key_describe

sync(id: UUID, client: AuthenticatedClient | Client) -> Any | ApiKeyApiModel | None

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

Returns: Any | ApiKeyApiModel | 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.

api_key_list

sync(client: AuthenticatedClient | Client, description: str | Unset = UNSET, hint: str | Unset = UNSET, owned_by_user_id: UUID | Unset = UNSET, owned_by_profile_id: UUID | Unset = UNSET, date_created: datetime.datetime | Unset = UNSET, date_last_modified: datetime.datetime | Unset = UNSET, created_by_user_id: UUID | Unset = UNSET, last_modified_by_user_id: UUID | Unset = UNSET, is_deleted: bool | Unset = UNSET, date_deleted: datetime.datetime | Unset = UNSET, deleted_by_user_id: UUID | Unset = UNSET, page: int | Unset = UNSET, page_size: int | Unset = UNSET) -> Any | list[ApiKeyListItemApiModel] | None

Parameter	Type	Default
client	AuthenticatedClient \| Client	required
description	str \| Unset	UNSET
hint	str \| Unset	UNSET
owned_by_user_id	UUID \| Unset	UNSET
owned_by_profile_id	UUID \| Unset	UNSET
date_created	datetime.datetime \| Unset	UNSET
date_last_modified	datetime.datetime \| Unset	UNSET
created_by_user_id	UUID \| Unset	UNSET
last_modified_by_user_id	UUID \| Unset	UNSET
is_deleted	bool \| Unset	UNSET
date_deleted	datetime.datetime \| Unset	UNSET
deleted_by_user_id	UUID \| Unset	UNSET
page	int \| Unset	UNSET
page_size	int \| Unset	UNSET

Returns: Any | list[ApiKeyListItemApiModel] | 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.

api_key_update

sync(id: UUID, client: AuthenticatedClient | Client, body: ApiKeyCreateApiModel | Unset = UNSET) -> Any | ApiKeyApiModel | None

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

Returns: Any | ApiKeyApiModel | 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.

api_key_validate

sync_detailed(client: AuthenticatedClient | Client, body: ApiKeyValidateApiModel | Unset = UNSET) -> Response[Any]

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

Returns: Response[Any]

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.