hyperstack.RbacRoleApi

All URIs are relative to https://infrahub-api.nexgencloud.com/v1

Method	HTTP request	Description
create_rbac_role	POST /auth/roles	Create RBAC Role
delete_a_rbac_role	DELETE /auth/roles/{id}	Delete a RBAC Role
get_a_rbac_role_detail	GET /auth/roles/{id}	Get a RBAC Role Detail
list_rbac_roles	GET /auth/roles	List RBAC Roles
update_a_rbac_role	PUT /auth/roles/{id}	Update a RBAC Role

create_rbac_role

RBACRole create_rbac_role(payload)

Create RBAC Role

Example

Api Key Authentication (apiKey):
Api Key Authentication (accessToken):

import hyperstack
from hyperstack.models.rbac_role import RBACRole
from hyperstack.models.rbac_role_payload import RBACRolePayload
from hyperstack.rest import ApiException
from pprint import pprint

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

# 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 API key authorization: apiKey
configuration.api_key['apiKey'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['apiKey'] = 'Bearer'

# Configure API key authorization: accessToken
configuration.api_key['accessToken'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['accessToken'] = 'Bearer'

# Enter a context with an instance of the API client
with hyperstack.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = hyperstack.RbacRoleApi(api_client)
    payload = hyperstack.RBACRolePayload() # RBACRolePayload | 

    try:
        # Create RBAC Role
        api_response = api_instance.create_rbac_role(payload)
        print("The response of RbacRoleApi->create_rbac_role:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling RbacRoleApi->create_rbac_role: %s\n" % e)

Parameters

Name	Type	Description	Notes
payload	RBACRolePayload

Return type

RBACRole

Authorization

apiKey, accessToken

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
201	Creating RBAC role success	-
400	Bad Request	-
401	Unauthorized	-
409	Conflict	-
500	Internal Server Error	-

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

delete_a_rbac_role

ResponseModel delete_a_rbac_role(id)

Delete a RBAC Role

Example

Api Key Authentication (apiKey):
Api Key Authentication (accessToken):

import hyperstack
from hyperstack.models.response_model import ResponseModel
from hyperstack.rest import ApiException
from pprint import pprint

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

# 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 API key authorization: apiKey
configuration.api_key['apiKey'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['apiKey'] = 'Bearer'

# Configure API key authorization: accessToken
configuration.api_key['accessToken'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['accessToken'] = 'Bearer'

# Enter a context with an instance of the API client
with hyperstack.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = hyperstack.RbacRoleApi(api_client)
    id = 56 # int | 

    try:
        # Delete a RBAC Role
        api_response = api_instance.delete_a_rbac_role(id)
        print("The response of RbacRoleApi->delete_a_rbac_role:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling RbacRoleApi->delete_a_rbac_role: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	int

Return type

ResponseModel

Authorization

apiKey, accessToken

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	RBAC Role deleted successfully	-
400	Bad Request	-
401	Unauthorized	-
404	Not Found	-
500	Internal Server Error	-

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

get_a_rbac_role_detail

RBACRole get_a_rbac_role_detail(id)

Get a RBAC Role Detail

Example

Api Key Authentication (apiKey):
Api Key Authentication (accessToken):

import hyperstack
from hyperstack.models.rbac_role import RBACRole
from hyperstack.rest import ApiException
from pprint import pprint

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

# 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 API key authorization: apiKey
configuration.api_key['apiKey'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['apiKey'] = 'Bearer'

# Configure API key authorization: accessToken
configuration.api_key['accessToken'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['accessToken'] = 'Bearer'

# Enter a context with an instance of the API client
with hyperstack.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = hyperstack.RbacRoleApi(api_client)
    id = 56 # int | 

    try:
        # Get a RBAC Role Detail
        api_response = api_instance.get_a_rbac_role_detail(id)
        print("The response of RbacRoleApi->get_a_rbac_role_detail:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling RbacRoleApi->get_a_rbac_role_detail: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	int

Return type

RBACRole

Authorization

apiKey, accessToken

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Getting RBAC role detail success	-
400	Bad Request	-
401	Unauthorized	-
404	Not Found	-
500	Internal Server Error	-

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

list_rbac_roles

RBACRoles list_rbac_roles()

List RBAC Roles

Example

Api Key Authentication (apiKey):
Api Key Authentication (accessToken):

import hyperstack
from hyperstack.models.rbac_roles import RBACRoles
from hyperstack.rest import ApiException
from pprint import pprint

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

# 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 API key authorization: apiKey
configuration.api_key['apiKey'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['apiKey'] = 'Bearer'

# Configure API key authorization: accessToken
configuration.api_key['accessToken'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['accessToken'] = 'Bearer'

# Enter a context with an instance of the API client
with hyperstack.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = hyperstack.RbacRoleApi(api_client)

    try:
        # List RBAC Roles
        api_response = api_instance.list_rbac_roles()
        print("The response of RbacRoleApi->list_rbac_roles:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling RbacRoleApi->list_rbac_roles: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

RBACRoles

Authorization

apiKey, accessToken

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Getting RBAC roles success	-
400	Bad Request	-
401	Unauthorized	-
500	Internal Server Error	-

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

update_a_rbac_role

RBACRole update_a_rbac_role(id, payload)

Update a RBAC Role

Example

Api Key Authentication (apiKey):
Api Key Authentication (accessToken):

import hyperstack
from hyperstack.models.rbac_role import RBACRole
from hyperstack.models.rbac_role_payload import RBACRolePayload
from hyperstack.rest import ApiException
from pprint import pprint

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

# 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 API key authorization: apiKey
configuration.api_key['apiKey'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['apiKey'] = 'Bearer'

# Configure API key authorization: accessToken
configuration.api_key['accessToken'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['accessToken'] = 'Bearer'

# Enter a context with an instance of the API client
with hyperstack.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = hyperstack.RbacRoleApi(api_client)
    id = 56 # int | 
    payload = hyperstack.RBACRolePayload() # RBACRolePayload | 

    try:
        # Update a RBAC Role
        api_response = api_instance.update_a_rbac_role(id, payload)
        print("The response of RbacRoleApi->update_a_rbac_role:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling RbacRoleApi->update_a_rbac_role: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	int
payload	RBACRolePayload

Return type

RBACRole

Authorization

apiKey, accessToken

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	RBAC Role updated successfully	-
400	Bad Request	-
401	Unauthorized	-
404	Not Found	-
500	Internal Server Error	-

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

Files

RbacRoleApi.md

Latest commit

History

RbacRoleApi.md

File metadata and controls

hyperstack.RbacRoleApi

create_rbac_role

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

delete_a_rbac_role

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_a_rbac_role_detail

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

list_rbac_roles

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

update_a_rbac_role

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details