flywheel.api.roles_api
RolesApi
Bases: object
add_role(body, **kwargs)
Add a new role
This method makes a synchronous HTTP request by default.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
body | RoleInput | | required |
async_ | (bool, optional) | Perform the request asynchronously | required |
add_role_with_http_info(body, **kwargs)
Add a new role
This method makes a synchronous HTTP request by default.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
body | RoleInput | | required |
async_ | (bool, optional) | Perform the request asynchronously | required |
delete_role(role_id, **kwargs)
Delete the role
This method makes a synchronous HTTP request by default.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
role_id | str | The ID of the role | required |
async_ | (bool, optional) | Perform the request asynchronously | required |
delete_role_with_http_info(role_id, **kwargs)
Delete the role
This method makes a synchronous HTTP request by default.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
role_id | str | The ID of the role | required |
async_ | (bool, optional) | Perform the request asynchronously | required |
get_all_roles(**kwargs)
Get list of all roles
Return a page of roles or all roles. 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_roles_with_http_info(**kwargs)
Get list of all roles
Return a page of roles or all roles. 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_role(role_id, **kwargs)
Return the role identified by the RoleId
This method makes a synchronous HTTP request by default.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
role_id | str | The ID of the role | required |
async_ | (bool, optional) | Perform the request asynchronously | required |
get_role_with_http_info(role_id, **kwargs)
Return the role identified by the RoleId
This method makes a synchronous HTTP request by default.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
role_id | str | The ID of the role | required |
async_ | (bool, optional) | Perform the request asynchronously | required |
modify_role(role_id, body, **kwargs)
Update the role identified by RoleId
This method makes a synchronous HTTP request by default.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
role_id | str | | required |
body | RoleUpdate | | required |
x_accept_feature | (list[union[HeaderFeature, str]], optional) | , defaults to [] | required |
async_ | (bool, optional) | Perform the request asynchronously | required |
modify_role_with_http_info(role_id, body, **kwargs)
Update the role identified by RoleId
This method makes a synchronous HTTP request by default.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
role_id | str | | required |
body | RoleUpdate | | required |
x_accept_feature | (list[union[HeaderFeature, str]], optional) | , defaults to [] | required |
async_ | (bool, optional) | Perform the request asynchronously | required |