Users
Classes for Users resources group
Classes:
| Name | Description |
|---|---|
Users |
Users resources method group main class |
Classes
Users
Bases: outline_wiki_api.resources.base.Resources
Users represent an individual with access to the knowledge base. Users
can be created automatically when signing in with SSO or when a user is
invited via email.
Methods:
| Name | Description |
|---|---|
info |
Retrieves a User object |
list |
Retrieves an Array of User objects |
update_role |
Change a users role |
Functions
info
Retrieves a User object representing an individual with access to the knowledge base. Users can be created automatically when signing in with SSO or when a user is invited via email. Args: user_id: The User to retrieve
Returns:
| Name | Type | Description |
|---|---|---|
UserResponse |
outline_wiki_api.models.user.UserResponse
|
a response objects which contains a User object as data |
list
List and filter all the users in the team
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
query
|
typing.Optional[str]
|
A text search query to filter by (searches in username and email) |
None
|
emails
|
typing.Optional[typing.List[pydantic.EmailStr]]
|
An array of emails to filter the output |
None
|
status
|
typing.Optional[typing.Literal['all', 'invited', 'active', 'suspended']]
|
The status to filter by |
None
|
role
|
typing.Optional[outline_wiki_api.models.user.UserRole]
|
The user role to filter by |
None
|
pagination
|
typing.Optional[outline_wiki_api.models.response.Pagination]
|
Custom pagination (default: offset=0, limit=25) |
None
|
sorting
|
typing.Optional[outline_wiki_api.models.response.Sort]
|
Custom sorting order (takes |
None
|
Returns:
| Name | Type | Description |
|---|---|---|
UserListResponse |
outline_wiki_api.models.user.UserListResponse
|
a response objects which contains an array of User objects as data |
update_role
Change the role of a user, only available to admin authorization.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
user_id
|
typing.Union[str, uuid.UUID]
|
Unique identifier for the user. |
required |
role
|
outline_wiki_api.models.user.UserRole
|
Workspace-wide role |
required |
Returns:
| Name | Type | Description |
|---|---|---|
UserResponse |
outline_wiki_api.models.user.UserResponse
|
a response objects which contains a User object as data |