Data API — Users

20 min

user_create

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

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

body — Request to create a new user

Returns: ProblemDetails | UserResponse | 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.

user_current_detail_describe

sync(client: AuthenticatedClient | Client) -> ProblemDetails | UserResponse | list[ErrorResponse] | None

Parameter	Type	Default
client	AuthenticatedClient \| Client	required

Returns: ProblemDetails | UserResponse | 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.

user_current_user_rights_describe

sync(client: AuthenticatedClient | Client, page: int | Unset = UNSET, page_size: int | Unset = UNSET) -> ProblemDetails | list[ErrorResponse] | list[UserRightsListItemResponse] | None

Parameter	Type	Default
client	AuthenticatedClient \| Client	required
page	int \| Unset	UNSET
page_size	int \| Unset	UNSET

Returns: ProblemDetails | list[ErrorResponse] | list[UserRightsListItemResponse] | 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.

user_delete

sync(user_id: UUID, client: AuthenticatedClient | Client, target_state: UserDeleteEnum | Unset = UserDeleteEnum.INACTIVE) -> Any | ProblemDetails | list[ErrorResponse] | None

Parameter	Type	Default
user_id	UUID	required
client	AuthenticatedClient \| Client	required
target_state	UserDeleteEnum \| Unset	UserDeleteEnum.INACTIVE

target_state — Default: UserDeleteEnum.INACTIVE.

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.

user_details_describe

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

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

Returns: ProblemDetails | UserResponse | 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.

user_get_user_id_from_profile_id

sync(client: AuthenticatedClient | Client) -> IdResponse1 | ProblemDetails | list[ErrorResponse] | None

Parameter	Type	Default
client	AuthenticatedClient \| Client	required

Returns: IdResponse1 | 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.

user_profile_rights_describe

sync(profile_id: UUID, client: AuthenticatedClient | Client, page: int | Unset = UNSET, page_size: int | Unset = UNSET) -> ProblemDetails | list[ErrorResponse] | list[UserRightsListItemResponse] | None

Parameter	Type	Default
profile_id	UUID	required
client	AuthenticatedClient \| Client	required
page	int \| Unset	UNSET
page_size	int \| Unset	UNSET

Returns: ProblemDetails | list[ErrorResponse] | list[UserRightsListItemResponse] | 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.

user_update

sync(user_id: UUID, client: AuthenticatedClient | Client, body: UpdateUserRequest | Unset = UNSET) -> ProblemDetails | UserResponse | list[ErrorResponse] | None

Parameter	Type	Default
user_id	UUID	required
client	AuthenticatedClient \| Client	required
body	UpdateUserRequest \| Unset	UNSET

body — Request to update user details

Returns: ProblemDetails | UserResponse | 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.

user_user_list

sync(client: AuthenticatedClient | Client, short_name: str | Unset = UNSET, name: str | Unset = UNSET, first_name: str | Unset = UNSET, last_name: str | Unset = UNSET, external_id: UUID | Unset = UNSET, primary_email: str | Unset = UNSET, organization_name: list[str] | Unset = UNSET, state: list[UserStateEnum] | Unset = UNSET, page: int | Unset = UNSET, page_size: int | Unset = UNSET) -> ProblemDetails | list[ErrorResponse] | list[UserListItemResponse] | None

Parameter	Type	Default
client	AuthenticatedClient \| Client	required
short_name	str \| Unset	UNSET
name	str \| Unset	UNSET
first_name	str \| Unset	UNSET
last_name	str \| Unset	UNSET
external_id	UUID \| Unset	UNSET
primary_email	str \| Unset	UNSET
organization_name	list[str] \| Unset	UNSET
state	list[UserStateEnum] \| Unset	UNSET
page	int \| Unset	UNSET
page_size	int \| Unset	UNSET

Returns: ProblemDetails | list[ErrorResponse] | list[UserListItemResponse] | 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.

user_user_rights_describe

sync(user_id: UUID, client: AuthenticatedClient | Client, page: int | Unset = UNSET, page_size: int | Unset = UNSET) -> ProblemDetails | list[ErrorResponse] | list[UserRightsListItemResponse] | None

Parameter	Type	Default
user_id	UUID	required
client	AuthenticatedClient \| Client	required
page	int \| Unset	UNSET
page_size	int \| Unset	UNSET

Returns: ProblemDetails | list[ErrorResponse] | list[UserRightsListItemResponse] | 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.