flywheel.api.users_api
UsersApi
Bases: object
add_user(body, **kwargs)
Add a new user
This method makes a synchronous HTTP request by default.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
body | UserInput | | required |
async_ | (bool, optional) | Perform the request asynchronously | required |
add_user_with_http_info(body, **kwargs)
Add a new user
This method makes a synchronous HTTP request by default.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
body | UserInput | | required |
async_ | (bool, optional) | Perform the request asynchronously | required |
delete_user(user_id, **kwargs)
Delete a user
This method makes a synchronous HTTP request by default.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
user_id | str | | required |
async_ | (bool, optional) | Perform the request asynchronously | required |
delete_user_key(id_, **kwargs)
Delete User Api Key
This method makes a synchronous HTTP request by default.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
id_ | str | | required |
async_ | (bool, optional) | Perform the request asynchronously | required |
delete_user_key_with_http_info(id_, **kwargs)
Delete User Api Key
This method makes a synchronous HTTP request by default.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
id_ | str | | required |
async_ | (bool, optional) | Perform the request asynchronously | required |
delete_user_with_http_info(user_id, **kwargs)
Delete a user
This method makes a synchronous HTTP request by default.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
user_id | str | | required |
async_ | (bool, optional) | Perform the request asynchronously | required |
generate_user_key(body, **kwargs)
Generates user api key
Generate user api key for the current user. This method makes a synchronous HTTP request by default.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
body | CoreModelsApiKeyApiKeyInput | | required |
async_ | (bool, optional) | Perform the request asynchronously | required |
generate_user_key_with_http_info(body, **kwargs)
Generates user api key
Generate user api key for the current user. This method makes a synchronous HTTP request by default.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
body | CoreModelsApiKeyApiKeyInput | | required |
async_ | (bool, optional) | Perform the request asynchronously | required |
get_all_users(**kwargs)
Return a list of all users
Gets all users with pagination. This method makes a synchronous HTTP request by default.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
filter | (str, optional) | Comma separated filters to apply. Commas not used as separators must be escaped with backslash '\'. (e.g. label=my-label,created>2018-09-22) | required |
sort | (str, optional) | The sort fields and order. (e.g. label:asc,created:desc) | required |
limit | (int, optional) | The maximum number of entries to return. | required |
skip | (int, optional) | The number of entries to skip., defaults to 0 | required |
page | (int, optional) | The page number (i.e. skip limit*page entries) | required |
after_id | (str, optional) | Paginate after the given id. (Cannot be used with sort, page or skip) | required |
x_accept_feature | (list[str], optional) | , defaults to [] | required |
async_ | (bool, optional) | Perform the request asynchronously | required |
get_all_users_with_http_info(**kwargs)
Return a list of all users
Gets all users with pagination. This method makes a synchronous HTTP request by default.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
filter | (str, optional) | Comma separated filters to apply. Commas not used as separators must be escaped with backslash '\'. (e.g. label=my-label,created>2018-09-22) | required |
sort | (str, optional) | The sort fields and order. (e.g. label:asc,created:desc) | required |
limit | (int, optional) | The maximum number of entries to return. | required |
skip | (int, optional) | The number of entries to skip., defaults to 0 | required |
page | (int, optional) | The page number (i.e. skip limit*page entries) | required |
after_id | (str, optional) | Paginate after the given id. (Cannot be used with sort, page or skip) | required |
x_accept_feature | (list[str], optional) | , defaults to [] | required |
async_ | (bool, optional) | Perform the request asynchronously | required |
get_current_user(**kwargs)
Get information about the current user
Gets the current user. This method makes a synchronous HTTP request by default.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
async_ | (bool, optional) | Perform the request asynchronously | required |
get_current_user_avatar(**kwargs)
Get the avatar of the current user
Gets avatar of current user. This method makes a synchronous HTTP request by default.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
default | (str, optional) | | required |
async_ | (bool, optional) | Perform the request asynchronously | required |
get_current_user_avatar_with_http_info(**kwargs)
Get the avatar of the current user
Gets avatar of current user. This method makes a synchronous HTTP request by default.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
default | (str, optional) | | required |
async_ | (bool, optional) | Perform the request asynchronously | required |
get_current_user_info(**kwargs)
Get info of the current user
Gets user info fields. This method makes a synchronous HTTP request by default.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
fields | (str, optional) | Get only the specified fields from user's info. Accept multiple fields separated by comma. | required |
async_ | (bool, optional) | Perform the request asynchronously | required |
get_current_user_info_with_http_info(**kwargs)
Get info of the current user
Gets user info fields. This method makes a synchronous HTTP request by default.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
fields | (str, optional) | Get only the specified fields from user's info. Accept multiple fields separated by comma. | required |
async_ | (bool, optional) | Perform the request asynchronously | required |
get_current_user_jobs(**kwargs)
Return list of jobs created by the current user
Gets jobs assigned to user with optional gear name regex. This method makes a synchronous HTTP request by default.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
gear | (str, optional) | Gear name. Get only the jobs which are related to a specific gear. | required |
exhaustive | (bool, optional) | , defaults to false | required |
filter | (str, optional) | Comma separated filters to apply. Commas not used as separators must be escaped with backslash '\'. (e.g. label=my-label,created>2018-09-22) | required |
sort | (str, optional) | The sort fields and order. (e.g. label:asc,created:desc) | required |
limit | (int, optional) | The maximum number of entries to return. | required |
skip | (int, optional) | The number of entries to skip., defaults to 0 | required |
page | (int, optional) | The page number (i.e. skip limit*page entries) | required |
after_id | (str, optional) | Paginate after the given id. (Cannot be used with sort, page or skip) | required |
x_accept_feature | (list[str], optional) | , defaults to [] | required |
async_ | (bool, optional) | Perform the request asynchronously | required |
get_current_user_jobs_with_http_info(**kwargs)
Return list of jobs created by the current user
Gets jobs assigned to user with optional gear name regex. This method makes a synchronous HTTP request by default.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
gear | (str, optional) | Gear name. Get only the jobs which are related to a specific gear. | required |
exhaustive | (bool, optional) | , defaults to false | required |
filter | (str, optional) | Comma separated filters to apply. Commas not used as separators must be escaped with backslash '\'. (e.g. label=my-label,created>2018-09-22) | required |
sort | (str, optional) | The sort fields and order. (e.g. label:asc,created:desc) | required |
limit | (int, optional) | The maximum number of entries to return. | required |
skip | (int, optional) | The number of entries to skip., defaults to 0 | required |
page | (int, optional) | The page number (i.e. skip limit*page entries) | required |
after_id | (str, optional) | Paginate after the given id. (Cannot be used with sort, page or skip) | required |
x_accept_feature | (list[str], optional) | , defaults to [] | required |
async_ | (bool, optional) | Perform the request asynchronously | required |
get_current_user_with_http_info(**kwargs)
Get information about the current user
Gets the current user. This method makes a synchronous HTTP request by default.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
async_ | (bool, optional) | Perform the request asynchronously | required |
get_user(user_id, **kwargs)
Get information about the specified user
Get user by id. This method makes a synchronous HTTP request by default.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
user_id | str | | required |
include_deleted | (bool, optional) | , defaults to false | required |
async_ | (bool, optional) | Perform the request asynchronously | required |
get_user_acquisitions(uid, **kwargs)
Get all acquisitions that belong to the given user.
This method makes a synchronous HTTP request by default.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
uid | str | | required |
exhaustive | (bool, optional) | Set to return a complete list regardless of permissions | required |
include_all_info | (bool, optional) | Include all info in returned objects, defaults to false | required |
filter | (str, optional) | Comma separated filters to apply. Commas not used as separators must be escaped with backslash '\'. (e.g. label=my-label,created>2018-09-22) | required |
sort | (str, optional) | The sort fields and order. (e.g. label:asc,created:desc) | required |
limit | (int, optional) | The maximum number of entries to return. | required |
skip | (int, optional) | The number of entries to skip., defaults to 0 | required |
page | (int, optional) | The page number (i.e. skip limit*page entries) | required |
after_id | (str, optional) | Paginate after the given id. (Cannot be used with sort, page or skip) | required |
async_ | (bool, optional) | Perform the request asynchronously | required |
get_user_acquisitions_with_http_info(uid, **kwargs)
Get all acquisitions that belong to the given user.
This method makes a synchronous HTTP request by default.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
uid | str | | required |
exhaustive | (bool, optional) | Set to return a complete list regardless of permissions | required |
include_all_info | (bool, optional) | Include all info in returned objects, defaults to false | required |
filter | (str, optional) | Comma separated filters to apply. Commas not used as separators must be escaped with backslash '\'. (e.g. label=my-label,created>2018-09-22) | required |
sort | (str, optional) | The sort fields and order. (e.g. label:asc,created:desc) | required |
limit | (int, optional) | The maximum number of entries to return. | required |
skip | (int, optional) | The number of entries to skip., defaults to 0 | required |
page | (int, optional) | The page number (i.e. skip limit*page entries) | required |
after_id | (str, optional) | Paginate after the given id. (Cannot be used with sort, page or skip) | required |
async_ | (bool, optional) | Perform the request asynchronously | required |
get_user_avatar(user_id, **kwargs)
Get the avatar of the specified user
Gets avatar of user and redirects to it. This method makes a synchronous HTTP request by default.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
user_id | str | | required |
default | (str, optional) | | required |
async_ | (bool, optional) | Perform the request asynchronously | required |
get_user_avatar_with_http_info(user_id, **kwargs)
Get the avatar of the specified user
Gets avatar of user and redirects to it. This method makes a synchronous HTTP request by default.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
user_id | str | | required |
default | (str, optional) | | required |
async_ | (bool, optional) | Perform the request asynchronously | required |
get_user_collections(user_id, **kwargs)
Get all collections that belong to the given user.
This method makes a synchronous HTTP request by default.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
user_id | str | | required |
filter | (str, optional) | Comma separated filters to apply. Commas not used as separators must be escaped with backslash '\'. (e.g. label=my-label,created>2018-09-22) | required |
sort | (str, optional) | The sort fields and order. (e.g. label:asc,created:desc) | required |
limit | (int, optional) | The maximum number of entries to return. | required |
skip | (int, optional) | The number of entries to skip., defaults to 0 | required |
page | (int, optional) | The page number (i.e. skip limit*page entries) | required |
after_id | (str, optional) | Paginate after the given id. (Cannot be used with sort, page or skip) | required |
x_accept_feature | (list[str], optional) | , defaults to [] | required |
async_ | (bool, optional) | Perform the request asynchronously | required |
get_user_collections_with_http_info(user_id, **kwargs)
Get all collections that belong to the given user.
This method makes a synchronous HTTP request by default.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
user_id | str | | required |
filter | (str, optional) | Comma separated filters to apply. Commas not used as separators must be escaped with backslash '\'. (e.g. label=my-label,created>2018-09-22) | required |
sort | (str, optional) | The sort fields and order. (e.g. label:asc,created:desc) | required |
limit | (int, optional) | The maximum number of entries to return. | required |
skip | (int, optional) | The number of entries to skip., defaults to 0 | required |
page | (int, optional) | The page number (i.e. skip limit*page entries) | required |
after_id | (str, optional) | Paginate after the given id. (Cannot be used with sort, page or skip) | required |
x_accept_feature | (list[str], optional) | , defaults to [] | required |
async_ | (bool, optional) | Perform the request asynchronously | required |
get_user_groups(uid, **kwargs)
List all groups the specified user is a member of
This method makes a synchronous HTTP request by default.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
uid | str | | required |
exhaustive | (bool, optional) | Set to return a complete list regardless of permissions | required |
filter | (str, optional) | Comma separated filters to apply. Commas not used as separators must be escaped with backslash '\'. (e.g. label=my-label,created>2018-09-22) | required |
sort | (str, optional) | The sort fields and order. (e.g. label:asc,created:desc) | required |
limit | (int, optional) | The maximum number of entries to return. | required |
skip | (int, optional) | The number of entries to skip., defaults to 0 | required |
page | (int, optional) | The page number (i.e. skip limit*page entries) | required |
after_id | (str, optional) | Paginate after the given id. (Cannot be used with sort, page or skip) | required |
x_accept_feature | (list[str], optional) | redirect header, defaults to [] | required |
async_ | (bool, optional) | Perform the request asynchronously | required |
get_user_groups_with_http_info(uid, **kwargs)
List all groups the specified user is a member of
This method makes a synchronous HTTP request by default.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
uid | str | | required |
exhaustive | (bool, optional) | Set to return a complete list regardless of permissions | required |
filter | (str, optional) | Comma separated filters to apply. Commas not used as separators must be escaped with backslash '\'. (e.g. label=my-label,created>2018-09-22) | required |
sort | (str, optional) | The sort fields and order. (e.g. label:asc,created:desc) | required |
limit | (int, optional) | The maximum number of entries to return. | required |
skip | (int, optional) | The number of entries to skip., defaults to 0 | required |
page | (int, optional) | The page number (i.e. skip limit*page entries) | required |
after_id | (str, optional) | Paginate after the given id. (Cannot be used with sort, page or skip) | required |
x_accept_feature | (list[str], optional) | redirect header, defaults to [] | required |
async_ | (bool, optional) | Perform the request asynchronously | required |
get_user_projects(uid, **kwargs)
Get all projects that belong to the given user.
This method makes a synchronous HTTP request by default.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
uid | str | | required |
exhaustive | (bool, optional) | Set to return a complete list regardless of permissions | required |
include_all_info | (bool, optional) | Include all info in returned objects, defaults to false | required |
filter | (str, optional) | Comma separated filters to apply. Commas not used as separators must be escaped with backslash '\'. (e.g. label=my-label,created>2018-09-22) | required |
sort | (str, optional) | The sort fields and order. (e.g. label:asc,created:desc) | required |
limit | (int, optional) | The maximum number of entries to return. | required |
skip | (int, optional) | The number of entries to skip., defaults to 0 | required |
page | (int, optional) | The page number (i.e. skip limit*page entries) | required |
after_id | (str, optional) | Paginate after the given id. (Cannot be used with sort, page or skip) | required |
async_ | (bool, optional) | Perform the request asynchronously | required |
get_user_projects_with_http_info(uid, **kwargs)
Get all projects that belong to the given user.
This method makes a synchronous HTTP request by default.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
uid | str | | required |
exhaustive | (bool, optional) | Set to return a complete list regardless of permissions | required |
include_all_info | (bool, optional) | Include all info in returned objects, defaults to false | required |
filter | (str, optional) | Comma separated filters to apply. Commas not used as separators must be escaped with backslash '\'. (e.g. label=my-label,created>2018-09-22) | required |
sort | (str, optional) | The sort fields and order. (e.g. label:asc,created:desc) | required |
limit | (int, optional) | The maximum number of entries to return. | required |
skip | (int, optional) | The number of entries to skip., defaults to 0 | required |
page | (int, optional) | The page number (i.e. skip limit*page entries) | required |
after_id | (str, optional) | Paginate after the given id. (Cannot be used with sort, page or skip) | required |
async_ | (bool, optional) | Perform the request asynchronously | required |
get_user_sessions(uid, **kwargs)
Get all sessions that belong to the given user.
This method makes a synchronous HTTP request by default.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
uid | str | | required |
exhaustive | (bool, optional) | | required |
include_all_info | (bool, optional) | Include all info in returned objects, defaults to false | required |
filter | (str, optional) | Comma separated filters to apply. Commas not used as separators must be escaped with backslash '\'. (e.g. label=my-label,created>2018-09-22) | required |
sort | (str, optional) | The sort fields and order. (e.g. label:asc,created:desc) | required |
limit | (int, optional) | The maximum number of entries to return. | required |
skip | (int, optional) | The number of entries to skip., defaults to 0 | required |
page | (int, optional) | The page number (i.e. skip limit*page entries) | required |
after_id | (str, optional) | Paginate after the given id. (Cannot be used with sort, page or skip) | required |
async_ | (bool, optional) | Perform the request asynchronously | required |
get_user_sessions_with_http_info(uid, **kwargs)
Get all sessions that belong to the given user.
This method makes a synchronous HTTP request by default.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
uid | str | | required |
exhaustive | (bool, optional) | | required |
include_all_info | (bool, optional) | Include all info in returned objects, defaults to false | required |
filter | (str, optional) | Comma separated filters to apply. Commas not used as separators must be escaped with backslash '\'. (e.g. label=my-label,created>2018-09-22) | required |
sort | (str, optional) | The sort fields and order. (e.g. label:asc,created:desc) | required |
limit | (int, optional) | The maximum number of entries to return. | required |
skip | (int, optional) | The number of entries to skip., defaults to 0 | required |
page | (int, optional) | The page number (i.e. skip limit*page entries) | required |
after_id | (str, optional) | Paginate after the given id. (Cannot be used with sort, page or skip) | required |
async_ | (bool, optional) | Perform the request asynchronously | required |
get_user_with_http_info(user_id, **kwargs)
Get information about the specified user
Get user by id. This method makes a synchronous HTTP request by default.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
user_id | str | | required |
include_deleted | (bool, optional) | , defaults to false | required |
async_ | (bool, optional) | Perform the request asynchronously | required |
modify_current_user_info(body, **kwargs)
Update or replace info for the current user.
Modifies user info fields. This method makes a synchronous HTTP request by default.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
body | Info | | required |
async_ | (bool, optional) | Perform the request asynchronously | required |
modify_current_user_info_with_http_info(body, **kwargs)
Update or replace info for the current user.
Modifies user info fields. This method makes a synchronous HTTP request by default.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
body | Info | | required |
async_ | (bool, optional) | Perform the request asynchronously | required |
modify_user(uid, body, **kwargs)
Update the specified user
This method makes a synchronous HTTP request by default.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
uid | str | | required |
body | ModifyUserInput | | required |
clear_permissions | (bool, optional) | , defaults to false | required |
async_ | (bool, optional) | Perform the request asynchronously | required |
modify_user_with_http_info(uid, body, **kwargs)
Update the specified user
This method makes a synchronous HTTP request by default.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
uid | str | | required |
body | ModifyUserInput | | required |
clear_permissions | (bool, optional) | , defaults to false | required |
async_ | (bool, optional) | Perform the request asynchronously | required |
sync_user(cid, body, **kwargs)
Sync a center user to enterprise (Sync service use ONLY)
This method makes a synchronous HTTP request by default.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
cid | str | | required |
body | SyncUserInput | | required |
async_ | (bool, optional) | Perform the request asynchronously | required |
sync_user_with_http_info(cid, body, **kwargs)
Sync a center user to enterprise (Sync service use ONLY)
This method makes a synchronous HTTP request by default.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
cid | str | | required |
body | SyncUserInput | | required |
async_ | (bool, optional) | Perform the request asynchronously | required |