pfruck_contabo.RolesApi

All URIs are relative to https://api.contabo.com

Method	HTTP request	Description
create_role	POST /v1/roles	Create a new role
delete_role	DELETE /v1/roles/{roleId}	Delete existing role by id
retrieve_api_permissions_list	GET /v1/roles/api-permissions	List of API permissions
retrieve_role	GET /v1/roles/{roleId}	Get specific role by id
retrieve_role_list	GET /v1/roles	List roles
update_role	PUT /v1/roles/{roleId}	Update specific role by id

create_role

CreateRoleResponse create_role(x_request_id, create_role_request, x_trace_id=x_trace_id)

Create a new role

Create a new role. In order to get a list availbale api enpoints (apiName) and their actions please refer to the GET api-permissions endpoint. For specifying resources please enter tag ids. For those to take effect please assign them to a resource in the tag management api.

Example

Bearer (JWT) Authentication (bearer):

import pfruck_contabo
from pfruck_contabo.models.create_role_request import CreateRoleRequest
from pfruck_contabo.models.create_role_response import CreateRoleResponse
from pfruck_contabo.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.contabo.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pfruck_contabo.Configuration(
    host = "https://api.contabo.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization (JWT): bearer
configuration = pfruck_contabo.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with pfruck_contabo.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pfruck_contabo.RolesApi(api_client)
    x_request_id = '04e0f898-37b4-48bc-a794-1a57abe6aa31' # str | [Uuid4](https://en.wikipedia.org/wiki/Universally_unique_identifier#Version_4_(random)) to identify individual requests for support cases. You can use [uuidgenerator](https://www.uuidgenerator.net/version4) to generate them manually.
    create_role_request = pfruck_contabo.CreateRoleRequest() # CreateRoleRequest | 
    x_trace_id = 'x_trace_id_example' # str | Identifier to trace group of requests. (optional)

    try:
        # Create a new role
        api_response = api_instance.create_role(x_request_id, create_role_request, x_trace_id=x_trace_id)
        print("The response of RolesApi->create_role:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling RolesApi->create_role: %s\n" % e)

Parameters

Name	Type	Description	Notes
x_request_id	str	Uuid4 to identify individual requests for support cases. You can use uuidgenerator to generate them manually.
create_role_request	CreateRoleRequest
x_trace_id	str	Identifier to trace group of requests.	[optional]

Return type

CreateRoleResponse

Authorization

bearer

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
201	The response will be a JSON object and contains standard role attributes.	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

delete_role

delete_role(x_request_id, role_id, x_trace_id=x_trace_id)

Delete existing role by id

You can't delete a role if it is still assigned to a user. In such cases please remove the role from the users.

Example

Bearer (JWT) Authentication (bearer):

import pfruck_contabo
from pfruck_contabo.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.contabo.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pfruck_contabo.Configuration(
    host = "https://api.contabo.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization (JWT): bearer
configuration = pfruck_contabo.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with pfruck_contabo.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pfruck_contabo.RolesApi(api_client)
    x_request_id = '04e0f898-37b4-48bc-a794-1a57abe6aa31' # str | [Uuid4](https://en.wikipedia.org/wiki/Universally_unique_identifier#Version_4_(random)) to identify individual requests for support cases. You can use [uuidgenerator](https://www.uuidgenerator.net/version4) to generate them manually.
    role_id = 12345 # int | The identifier of the role
    x_trace_id = 'x_trace_id_example' # str | Identifier to trace group of requests. (optional)

    try:
        # Delete existing role by id
        api_instance.delete_role(x_request_id, role_id, x_trace_id=x_trace_id)
    except Exception as e:
        print("Exception when calling RolesApi->delete_role: %s\n" % e)

Parameters

Name	Type	Description	Notes
x_request_id	str	Uuid4 to identify individual requests for support cases. You can use uuidgenerator to generate them manually.
role_id	int	The identifier of the role
x_trace_id	str	Identifier to trace group of requests.	[optional]

Return type

void (empty response body)

Authorization

bearer

HTTP request headers

Content-Type: Not defined
Accept: Not defined

HTTP response details

Status code	Description	Response headers
204	Response body has no content	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

retrieve_api_permissions_list

ListApiPermissionResponse retrieve_api_permissions_list(x_request_id, x_trace_id=x_trace_id, page=page, size=size, order_by=order_by, api_name=api_name)

List of API permissions

List all available API permissions. This list serves as a reference for specifying roles. As endpoints differ in their possibilities not all actions are available for each endpoint.

Example

Bearer (JWT) Authentication (bearer):

import pfruck_contabo
from pfruck_contabo.models.list_api_permission_response import ListApiPermissionResponse
from pfruck_contabo.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.contabo.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pfruck_contabo.Configuration(
    host = "https://api.contabo.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization (JWT): bearer
configuration = pfruck_contabo.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with pfruck_contabo.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pfruck_contabo.RolesApi(api_client)
    x_request_id = '04e0f898-37b4-48bc-a794-1a57abe6aa31' # str | [Uuid4](https://en.wikipedia.org/wiki/Universally_unique_identifier#Version_4_(random)) to identify individual requests for support cases. You can use [uuidgenerator](https://www.uuidgenerator.net/version4) to generate them manually.
    x_trace_id = 'x_trace_id_example' # str | Identifier to trace group of requests. (optional)
    page = 1 # int | Number of page to be fetched. (optional)
    size = 10 # int | Number of elements per page. (optional)
    order_by = ['name:asc'] # List[str] | Specify fields and ordering (ASC for ascending, DESC for descending) in following format `field:ASC|DESC`. (optional)
    api_name = '/v1/compute/instances' # str | The name of api (optional)

    try:
        # List of API permissions
        api_response = api_instance.retrieve_api_permissions_list(x_request_id, x_trace_id=x_trace_id, page=page, size=size, order_by=order_by, api_name=api_name)
        print("The response of RolesApi->retrieve_api_permissions_list:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling RolesApi->retrieve_api_permissions_list: %s\n" % e)

Parameters

Name	Type	Description	Notes
x_request_id	str	Uuid4 to identify individual requests for support cases. You can use uuidgenerator to generate them manually.
x_trace_id	str	Identifier to trace group of requests.	[optional]
page	int	Number of page to be fetched.	[optional]
size	int	Number of elements per page.	[optional]
order_by	List[str]	Specify fields and ordering (ASC for ascending, DESC for descending) in following format `field:ASC	DESC`.
api_name	str	The name of api	[optional]

Return type

ListApiPermissionResponse

Authorization

bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	The response will be a JSON object and contains a paginated list of API permissions.	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

retrieve_role

FindRoleResponse retrieve_role(x_request_id, role_id, x_trace_id=x_trace_id)

Get specific role by id

Get attributes of specific role.

Example

Bearer (JWT) Authentication (bearer):

import pfruck_contabo
from pfruck_contabo.models.find_role_response import FindRoleResponse
from pfruck_contabo.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.contabo.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pfruck_contabo.Configuration(
    host = "https://api.contabo.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization (JWT): bearer
configuration = pfruck_contabo.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with pfruck_contabo.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pfruck_contabo.RolesApi(api_client)
    x_request_id = '04e0f898-37b4-48bc-a794-1a57abe6aa31' # str | [Uuid4](https://en.wikipedia.org/wiki/Universally_unique_identifier#Version_4_(random)) to identify individual requests for support cases. You can use [uuidgenerator](https://www.uuidgenerator.net/version4) to generate them manually.
    role_id = 12345 # int | The identifier of the role
    x_trace_id = 'x_trace_id_example' # str | Identifier to trace group of requests. (optional)

    try:
        # Get specific role by id
        api_response = api_instance.retrieve_role(x_request_id, role_id, x_trace_id=x_trace_id)
        print("The response of RolesApi->retrieve_role:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling RolesApi->retrieve_role: %s\n" % e)

Parameters

Name	Type	Description	Notes
x_request_id	str	Uuid4 to identify individual requests for support cases. You can use uuidgenerator to generate them manually.
role_id	int	The identifier of the role
x_trace_id	str	Identifier to trace group of requests.	[optional]

Return type

FindRoleResponse

Authorization

bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	The response will be a JSON object and contains standard role attributes.	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

retrieve_role_list

ListRoleResponse retrieve_role_list(x_request_id, x_trace_id=x_trace_id, page=page, size=size, order_by=order_by, name=name, api_name=api_name, tag_name=tag_name, type=type)

List roles

List and filter all your roles. A role allows you to specify permission to api endpoints and resources like compute.

Example

Bearer (JWT) Authentication (bearer):

import pfruck_contabo
from pfruck_contabo.models.list_role_response import ListRoleResponse
from pfruck_contabo.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.contabo.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pfruck_contabo.Configuration(
    host = "https://api.contabo.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization (JWT): bearer
configuration = pfruck_contabo.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with pfruck_contabo.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pfruck_contabo.RolesApi(api_client)
    x_request_id = '04e0f898-37b4-48bc-a794-1a57abe6aa31' # str | [Uuid4](https://en.wikipedia.org/wiki/Universally_unique_identifier#Version_4_(random)) to identify individual requests for support cases. You can use [uuidgenerator](https://www.uuidgenerator.net/version4) to generate them manually.
    x_trace_id = 'x_trace_id_example' # str | Identifier to trace group of requests. (optional)
    page = 1 # int | Number of page to be fetched. (optional)
    size = 10 # int | Number of elements per page. (optional)
    order_by = ['name:asc'] # List[str] | Specify fields and ordering (ASC for ascending, DESC for descending) in following format `field:ASC|DESC`. (optional)
    name = 'Web' # str | The name of the role (optional)
    api_name = '/v1/compute/instances' # str | The name of api (optional)
    tag_name = 'Web' # str | The name of the tag (optional)
    type = 'custom' # str | The type of the tag. Can be either `default` or `custom` (optional)

    try:
        # List roles
        api_response = api_instance.retrieve_role_list(x_request_id, x_trace_id=x_trace_id, page=page, size=size, order_by=order_by, name=name, api_name=api_name, tag_name=tag_name, type=type)
        print("The response of RolesApi->retrieve_role_list:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling RolesApi->retrieve_role_list: %s\n" % e)

Parameters

Name	Type	Description	Notes
x_request_id	str	Uuid4 to identify individual requests for support cases. You can use uuidgenerator to generate them manually.
x_trace_id	str	Identifier to trace group of requests.	[optional]
page	int	Number of page to be fetched.	[optional]
size	int	Number of elements per page.	[optional]
order_by	List[str]	Specify fields and ordering (ASC for ascending, DESC for descending) in following format `field:ASC	DESC`.
name	str	The name of the role	[optional]
api_name	str	The name of api	[optional]
tag_name	str	The name of the tag	[optional]
type	str	The type of the tag. Can be either `default` or `custom`	[optional]

Return type

ListRoleResponse

Authorization

bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	The response will be a JSON object and contains a paginated list of roles.	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

update_role

UpdateRoleResponse update_role(x_request_id, role_id, update_role_request, x_trace_id=x_trace_id)

Update specific role by id

Update attributes to your role. Attributes are optional. If not set, the attributes will retain their original values.

Example

Bearer (JWT) Authentication (bearer):

import pfruck_contabo
from pfruck_contabo.models.update_role_request import UpdateRoleRequest
from pfruck_contabo.models.update_role_response import UpdateRoleResponse
from pfruck_contabo.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.contabo.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pfruck_contabo.Configuration(
    host = "https://api.contabo.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization (JWT): bearer
configuration = pfruck_contabo.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with pfruck_contabo.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pfruck_contabo.RolesApi(api_client)
    x_request_id = '04e0f898-37b4-48bc-a794-1a57abe6aa31' # str | [Uuid4](https://en.wikipedia.org/wiki/Universally_unique_identifier#Version_4_(random)) to identify individual requests for support cases. You can use [uuidgenerator](https://www.uuidgenerator.net/version4) to generate them manually.
    role_id = 12345 # int | The identifier of the role
    update_role_request = pfruck_contabo.UpdateRoleRequest() # UpdateRoleRequest | 
    x_trace_id = 'x_trace_id_example' # str | Identifier to trace group of requests. (optional)

    try:
        # Update specific role by id
        api_response = api_instance.update_role(x_request_id, role_id, update_role_request, x_trace_id=x_trace_id)
        print("The response of RolesApi->update_role:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling RolesApi->update_role: %s\n" % e)

Parameters

Name	Type	Description	Notes
x_request_id	str	Uuid4 to identify individual requests for support cases. You can use uuidgenerator to generate them manually.
role_id	int	The identifier of the role
update_role_request	UpdateRoleRequest
x_trace_id	str	Identifier to trace group of requests.	[optional]

Return type

UpdateRoleResponse

Authorization

bearer

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	The response will be a JSON object and contains standard role attributes.	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Files

RolesApi.md

Latest commit

History

RolesApi.md

File metadata and controls

pfruck_contabo.RolesApi

create_role

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

delete_role

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

retrieve_api_permissions_list

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

retrieve_role

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

retrieve_role_list

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

update_role

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details