Data API — User Org Roles

8 min

user_org_role_create

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

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

body — Link a user to a specific organization's role that will grant that user rights

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_org_role_current_user_org_roles_describe

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

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

Returns: ProblemDetails | list[ErrorResponse] | list[UserOrgRoleListItemResponse] | 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_org_role_delete

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

Parameter	Type	Default
user_id	UUID	required
user_org_role_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.

user_org_role_get_by_user_id

sync(user_id: UUID, client: AuthenticatedClient | Client, page: int | Unset = UNSET, page_size: int | Unset = UNSET) -> ProblemDetails | list[ErrorResponse] | list[UserOrgRoleListItemResponse] | 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[UserOrgRoleListItemResponse] | 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.