pldpro_sdk.api_client.AuthNodesApi

All URIs are relative to http://localhost:8086

Method	HTTP request	Description
check_auth_node_health	GET /api/v1/nodes/auth/{uuid}/health	Verifica a saúde e a conectividade de um AuthNode
create_auth_node	POST /api/v2/auth-nodes	Cria um AuthNode
create_managed_ssh_auth_node_access	POST /api/v2/auth-nodes/managed-ssh-access	Cria acesso SSH gerenciado
delete_auth_node	DELETE /api/v2/auth-nodes/{uuid}	Remove um AuthNode
delete_auth_node_key	DELETE /api/v2/auth-nodes/{authNodeId}/key	Remove a chave privada de um AuthNode
delete_auth_node_password	DELETE /api/v2/auth-nodes/{authNodeId}/pass	Remove a senha de um AuthNode
delete_auth_node_token	DELETE /api/v2/auth-nodes/{authNodeId}/token	Remove o token de um AuthNode
get_auth_node_by_uuid	GET /api/v2/auth-nodes/{uuid}	Busca um AuthNode por UUID
get_managed_ssh_auth_node_public_key	GET /api/v2/auth-nodes/{uuid}/managed-ssh-access/public-key	Consulta a chave pública SSH gerenciada
get_versoes_container	GET /api/v1/nodes/auth/{uuid}/versions	Lista as versões disponíveis do PLDPro para um AuthNode
list_auth_nodes	GET /api/v2/auth-nodes	Lista AuthNodes
list_current_user_auth_nodes	GET /api/v2/auth-nodes/me	Lista AuthNodes do usuário autenticado
list_executions_by_auth_node	GET /api/v1/nodes/auth/{uuid}/execution	Lista o status das execuções associadas a um AuthNode
list_user_auth_nodes	GET /api/v2/auth-nodes/user/{user_uuid}	Lista AuthNodes de um usuário
provision_managed_ssh_auth_node_public_key	POST /api/v2/auth-nodes/{uuid}/managed-ssh-access/provision	Instala a chave pública SSH gerenciada
rotate_managed_ssh_auth_node_key_pair	PUT /api/v2/auth-nodes/{uuid}/managed-ssh-access/key-pair	Rotaciona o par de chaves SSH gerenciado
update_auth_node	PUT /api/v2/auth-nodes/{uuid}	Atualiza um AuthNode
update_auth_nodes_batch	PUT /api/v2/auth-nodes/list	Atualiza AuthNodes em lote
update_current_user_auth_node_access	POST /api/v2/auth-nodes/me/access	Atualiza o acesso AuthNode do usuário autenticado

check_auth_node_health

HostCheckResult check_auth_node_health(uuid)

Verifica a saúde e a conectividade de um AuthNode

Realiza uma verificação de integridade das credenciais remotas associadas ao AuthNode identificado pelo UUID.

O retorno informa se o registro existe no banco, se há chave SSH disponível, se a conexão foi bem-sucedida e uma mensagem descritiva.

Example

• Api Key Authentication (1_tenant):
• Api Key Authentication (4_roles):
• Bearer (JWT) Authentication (security_auth):
• Api Key Authentication (2_user):
• Api Key Authentication (ApiKeyAuth):
• Api Key Authentication (3_user_id):

import pldpro_sdk.api_client
from pldpro_sdk.api_client.models.host_check_result import HostCheckResult
from pldpro_sdk.api_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost:8086
# See configuration.py for a list of all supported configuration parameters.
configuration = pldpro_sdk.api_client.Configuration(
    host = "http://localhost:8086"
)

# 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: 1_tenant
configuration.api_key['1_tenant'] = os.environ["API_KEY"]

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

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

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

# Configure Bearer authorization (JWT): security_auth
configuration = pldpro_sdk.api_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

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

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

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

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

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

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

# Enter a context with an instance of the API client
with pldpro_sdk.api_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pldpro_sdk.api_client.AuthNodesApi(api_client)
    uuid = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | Identificador único do AuthNode a ser verificado.

    try:
        # Verifica a saúde e a conectividade de um AuthNode
        api_response = api_instance.check_auth_node_health(uuid)
        print("The response of AuthNodesApi->check_auth_node_health:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AuthNodesApi->check_auth_node_health: %s\n" % e)

Parameters

Name	Type	Description	Notes
uuid	UUID	Identificador único do AuthNode a ser verificado.

Return type

HostCheckResult

Authorization

1_tenant, 4_roles, security_auth, 2_user, ApiKeyAuth, 3_user_id

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Resultado da verificação de saúde do AuthNode e do node remoto.	-
404	AuthNode não encontrado.	-
400	Erro ao verificar o estado do AuthNode e do node remoto.	-

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

create_auth_node

AuthNodeResponseDTO create_auth_node(auth_node_request_dto)

Cria um AuthNode

Cria uma associação genérica de AuthNode entre um Node e um usuário.

Example

• Api Key Authentication (1_tenant):
• Api Key Authentication (4_roles):
• Bearer (JWT) Authentication (security_auth):
• Api Key Authentication (2_user):
• Api Key Authentication (ApiKeyAuth):
• Api Key Authentication (3_user_id):

import pldpro_sdk.api_client
from pldpro_sdk.api_client.models.auth_node_request_dto import AuthNodeRequestDTO
from pldpro_sdk.api_client.models.auth_node_response_dto import AuthNodeResponseDTO
from pldpro_sdk.api_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost:8086
# See configuration.py for a list of all supported configuration parameters.
configuration = pldpro_sdk.api_client.Configuration(
    host = "http://localhost:8086"
)

# 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: 1_tenant
configuration.api_key['1_tenant'] = os.environ["API_KEY"]

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

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

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

# Configure Bearer authorization (JWT): security_auth
configuration = pldpro_sdk.api_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

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

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

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

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

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

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

# Enter a context with an instance of the API client
with pldpro_sdk.api_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pldpro_sdk.api_client.AuthNodesApi(api_client)
    auth_node_request_dto = pldpro_sdk.api_client.AuthNodeRequestDTO() # AuthNodeRequestDTO | 

    try:
        # Cria um AuthNode
        api_response = api_instance.create_auth_node(auth_node_request_dto)
        print("The response of AuthNodesApi->create_auth_node:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AuthNodesApi->create_auth_node: %s\n" % e)

Parameters

Name	Type	Description	Notes
auth_node_request_dto	AuthNodeRequestDTO

Return type

AuthNodeResponseDTO

Authorization

1_tenant, 4_roles, security_auth, 2_user, ApiKeyAuth, 3_user_id

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	AuthNode criado com sucesso.	-
400	Requisição de AuthNode inválida.	-

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

create_managed_ssh_auth_node_access

AuthNodeSshAccessResponseDTO create_managed_ssh_auth_node_access(auth_node_ssh_access_request_dto)

Cria acesso SSH gerenciado

Cria um AuthNode para o usuário autenticado e gera um par de chaves SSH gerenciado pelo sistema. A chave privada é persistida de forma criptografada e não é retornada. Quando uma senha é informada, ela é usada somente para instalar a chave pública no host remoto.

Example

• Api Key Authentication (1_tenant):
• Api Key Authentication (4_roles):
• Bearer (JWT) Authentication (security_auth):
• Api Key Authentication (2_user):
• Api Key Authentication (ApiKeyAuth):
• Api Key Authentication (3_user_id):

import pldpro_sdk.api_client
from pldpro_sdk.api_client.models.auth_node_ssh_access_request_dto import AuthNodeSshAccessRequestDTO
from pldpro_sdk.api_client.models.auth_node_ssh_access_response_dto import AuthNodeSshAccessResponseDTO
from pldpro_sdk.api_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost:8086
# See configuration.py for a list of all supported configuration parameters.
configuration = pldpro_sdk.api_client.Configuration(
    host = "http://localhost:8086"
)

# 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: 1_tenant
configuration.api_key['1_tenant'] = os.environ["API_KEY"]

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

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

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

# Configure Bearer authorization (JWT): security_auth
configuration = pldpro_sdk.api_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

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

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

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

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

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

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

# Enter a context with an instance of the API client
with pldpro_sdk.api_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pldpro_sdk.api_client.AuthNodesApi(api_client)
    auth_node_ssh_access_request_dto = pldpro_sdk.api_client.AuthNodeSshAccessRequestDTO() # AuthNodeSshAccessRequestDTO | 

    try:
        # Cria acesso SSH gerenciado
        api_response = api_instance.create_managed_ssh_auth_node_access(auth_node_ssh_access_request_dto)
        print("The response of AuthNodesApi->create_managed_ssh_auth_node_access:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AuthNodesApi->create_managed_ssh_auth_node_access: %s\n" % e)

Parameters

Name	Type	Description	Notes
auth_node_ssh_access_request_dto	AuthNodeSshAccessRequestDTO

Return type

AuthNodeSshAccessResponseDTO

Authorization

1_tenant, 4_roles, security_auth, 2_user, ApiKeyAuth, 3_user_id

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	Acesso SSH gerenciado criado com sucesso.	-
400	Dados de acesso SSH inválidos.	-
409	Já existe um AuthNode para o usuário autenticado neste Node.	-

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

delete_auth_node

delete_auth_node(uuid)

Remove um AuthNode

Remove o AuthNode compartilhado identificado pelo UUID.

Example

• Api Key Authentication (1_tenant):
• Api Key Authentication (4_roles):
• Bearer (JWT) Authentication (security_auth):
• Api Key Authentication (2_user):
• Api Key Authentication (ApiKeyAuth):
• Api Key Authentication (3_user_id):

import pldpro_sdk.api_client
from pldpro_sdk.api_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost:8086
# See configuration.py for a list of all supported configuration parameters.
configuration = pldpro_sdk.api_client.Configuration(
    host = "http://localhost:8086"
)

# 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: 1_tenant
configuration.api_key['1_tenant'] = os.environ["API_KEY"]

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

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

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

# Configure Bearer authorization (JWT): security_auth
configuration = pldpro_sdk.api_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

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

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

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

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

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

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

# Enter a context with an instance of the API client
with pldpro_sdk.api_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pldpro_sdk.api_client.AuthNodesApi(api_client)
    uuid = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | 

    try:
        # Remove um AuthNode
        api_instance.delete_auth_node(uuid)
    except Exception as e:
        print("Exception when calling AuthNodesApi->delete_auth_node: %s\n" % e)

Parameters

Name	Type	Description	Notes
uuid	UUID

Return type

void (empty response body)

Authorization

1_tenant, 4_roles, security_auth, 2_user, ApiKeyAuth, 3_user_id

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

HTTP response details

Status code	Description	Response headers
204	AuthNode removido com sucesso.	-
404	AuthNode não encontrado.	-

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

delete_auth_node_key

delete_auth_node_key(auth_node_id)

Remove a chave privada de um AuthNode

Remove a chave privada associada a um AuthNode.

Example

• Api Key Authentication (1_tenant):
• Api Key Authentication (4_roles):
• Bearer (JWT) Authentication (security_auth):
• Api Key Authentication (2_user):
• Api Key Authentication (ApiKeyAuth):
• Api Key Authentication (3_user_id):

import pldpro_sdk.api_client
from pldpro_sdk.api_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost:8086
# See configuration.py for a list of all supported configuration parameters.
configuration = pldpro_sdk.api_client.Configuration(
    host = "http://localhost:8086"
)

# 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: 1_tenant
configuration.api_key['1_tenant'] = os.environ["API_KEY"]

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

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

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

# Configure Bearer authorization (JWT): security_auth
configuration = pldpro_sdk.api_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

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

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

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

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

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

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

# Enter a context with an instance of the API client
with pldpro_sdk.api_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pldpro_sdk.api_client.AuthNodesApi(api_client)
    auth_node_id = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | 

    try:
        # Remove a chave privada de um AuthNode
        api_instance.delete_auth_node_key(auth_node_id)
    except Exception as e:
        print("Exception when calling AuthNodesApi->delete_auth_node_key: %s\n" % e)

Parameters

Name	Type	Description	Notes
auth_node_id	UUID

Return type

void (empty response body)

Authorization

1_tenant, 4_roles, security_auth, 2_user, ApiKeyAuth, 3_user_id

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

HTTP response details

Status code	Description	Response headers
204	Chave privada do AuthNode removida com sucesso.	-

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

delete_auth_node_password

delete_auth_node_password(auth_node_id)

Remove a senha de um AuthNode

Remove a senha associada a um AuthNode.

Example

• Api Key Authentication (1_tenant):
• Api Key Authentication (4_roles):
• Bearer (JWT) Authentication (security_auth):
• Api Key Authentication (2_user):
• Api Key Authentication (ApiKeyAuth):
• Api Key Authentication (3_user_id):

import pldpro_sdk.api_client
from pldpro_sdk.api_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost:8086
# See configuration.py for a list of all supported configuration parameters.
configuration = pldpro_sdk.api_client.Configuration(
    host = "http://localhost:8086"
)

# 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: 1_tenant
configuration.api_key['1_tenant'] = os.environ["API_KEY"]

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

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

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

# Configure Bearer authorization (JWT): security_auth
configuration = pldpro_sdk.api_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

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

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

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

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

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

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

# Enter a context with an instance of the API client
with pldpro_sdk.api_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pldpro_sdk.api_client.AuthNodesApi(api_client)
    auth_node_id = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | 

    try:
        # Remove a senha de um AuthNode
        api_instance.delete_auth_node_password(auth_node_id)
    except Exception as e:
        print("Exception when calling AuthNodesApi->delete_auth_node_password: %s\n" % e)

Parameters

Name	Type	Description	Notes
auth_node_id	UUID

Return type

void (empty response body)

Authorization

1_tenant, 4_roles, security_auth, 2_user, ApiKeyAuth, 3_user_id

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

HTTP response details

Status code	Description	Response headers
204	Senha do AuthNode removida com sucesso.	-

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

delete_auth_node_token

delete_auth_node_token(auth_node_id)

Remove o token de um AuthNode

Remove o token associado a um AuthNode.

Example

• Api Key Authentication (1_tenant):
• Api Key Authentication (4_roles):
• Bearer (JWT) Authentication (security_auth):
• Api Key Authentication (2_user):
• Api Key Authentication (ApiKeyAuth):
• Api Key Authentication (3_user_id):

import pldpro_sdk.api_client
from pldpro_sdk.api_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost:8086
# See configuration.py for a list of all supported configuration parameters.
configuration = pldpro_sdk.api_client.Configuration(
    host = "http://localhost:8086"
)

# 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: 1_tenant
configuration.api_key['1_tenant'] = os.environ["API_KEY"]

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

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

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

# Configure Bearer authorization (JWT): security_auth
configuration = pldpro_sdk.api_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

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

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

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

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

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

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

# Enter a context with an instance of the API client
with pldpro_sdk.api_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pldpro_sdk.api_client.AuthNodesApi(api_client)
    auth_node_id = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | 

    try:
        # Remove o token de um AuthNode
        api_instance.delete_auth_node_token(auth_node_id)
    except Exception as e:
        print("Exception when calling AuthNodesApi->delete_auth_node_token: %s\n" % e)

Parameters

Name	Type	Description	Notes
auth_node_id	UUID

Return type

void (empty response body)

Authorization

1_tenant, 4_roles, security_auth, 2_user, ApiKeyAuth, 3_user_id

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

HTTP response details

Status code	Description	Response headers
204	Token do AuthNode removido com sucesso.	-

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

get_auth_node_by_uuid

AuthNodeResponseDTO get_auth_node_by_uuid(uuid)

Busca um AuthNode por UUID

Retorna o AuthNode compartilhado identificado pelo UUID.

Example

• Api Key Authentication (1_tenant):
• Api Key Authentication (4_roles):
• Bearer (JWT) Authentication (security_auth):
• Api Key Authentication (2_user):
• Api Key Authentication (ApiKeyAuth):
• Api Key Authentication (3_user_id):

import pldpro_sdk.api_client
from pldpro_sdk.api_client.models.auth_node_response_dto import AuthNodeResponseDTO
from pldpro_sdk.api_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost:8086
# See configuration.py for a list of all supported configuration parameters.
configuration = pldpro_sdk.api_client.Configuration(
    host = "http://localhost:8086"
)

# 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: 1_tenant
configuration.api_key['1_tenant'] = os.environ["API_KEY"]

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

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

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

# Configure Bearer authorization (JWT): security_auth
configuration = pldpro_sdk.api_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

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

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

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

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

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

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

# Enter a context with an instance of the API client
with pldpro_sdk.api_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pldpro_sdk.api_client.AuthNodesApi(api_client)
    uuid = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | 

    try:
        # Busca um AuthNode por UUID
        api_response = api_instance.get_auth_node_by_uuid(uuid)
        print("The response of AuthNodesApi->get_auth_node_by_uuid:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AuthNodesApi->get_auth_node_by_uuid: %s\n" % e)

Parameters

Name	Type	Description	Notes
uuid	UUID

Return type

AuthNodeResponseDTO

Authorization

1_tenant, 4_roles, security_auth, 2_user, ApiKeyAuth, 3_user_id

HTTP request headers

• Content-Type: Not defined
• Accept: /

HTTP response details

Status code	Description	Response headers
200	AuthNode retornado com sucesso.	-
404	AuthNode não encontrado.	-

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

get_managed_ssh_auth_node_public_key

AuthNodeSshPublicKeyResponseDTO get_managed_ssh_auth_node_public_key(uuid)

Consulta a chave pública SSH gerenciada

Retorna a chave pública do sistema para instalação manual no host remoto.

Example

• Api Key Authentication (1_tenant):
• Api Key Authentication (4_roles):
• Bearer (JWT) Authentication (security_auth):
• Api Key Authentication (2_user):
• Api Key Authentication (ApiKeyAuth):
• Api Key Authentication (3_user_id):

import pldpro_sdk.api_client
from pldpro_sdk.api_client.models.auth_node_ssh_public_key_response_dto import AuthNodeSshPublicKeyResponseDTO
from pldpro_sdk.api_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost:8086
# See configuration.py for a list of all supported configuration parameters.
configuration = pldpro_sdk.api_client.Configuration(
    host = "http://localhost:8086"
)

# 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: 1_tenant
configuration.api_key['1_tenant'] = os.environ["API_KEY"]

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

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

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

# Configure Bearer authorization (JWT): security_auth
configuration = pldpro_sdk.api_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

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

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

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

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

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

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

# Enter a context with an instance of the API client
with pldpro_sdk.api_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pldpro_sdk.api_client.AuthNodesApi(api_client)
    uuid = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | 

    try:
        # Consulta a chave pública SSH gerenciada
        api_response = api_instance.get_managed_ssh_auth_node_public_key(uuid)
        print("The response of AuthNodesApi->get_managed_ssh_auth_node_public_key:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AuthNodesApi->get_managed_ssh_auth_node_public_key: %s\n" % e)

Parameters

Name	Type	Description	Notes
uuid	UUID

Return type

AuthNodeSshPublicKeyResponseDTO

Authorization

1_tenant, 4_roles, security_auth, 2_user, ApiKeyAuth, 3_user_id

HTTP request headers

• Content-Type: Not defined
• Accept: /

HTTP response details

Status code	Description	Response headers
200	Chave pública retornada com sucesso.	-
404	AuthNode ou chave SSH não encontrado.	-

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

get_versoes_container

List[str] get_versoes_container(uuid)

Lista as versões disponíveis do PLDPro para um AuthNode

Retorna uma lista com as versões do PLDPro disponíveis para o AuthNode identificado pelo UUID informado.

A lista reflete as versões de container detectadas no node remoto associado ao AuthNode.

Example

• Api Key Authentication (1_tenant):
• Api Key Authentication (4_roles):
• Bearer (JWT) Authentication (security_auth):
• Api Key Authentication (2_user):
• Api Key Authentication (ApiKeyAuth):
• Api Key Authentication (3_user_id):

import pldpro_sdk.api_client
from pldpro_sdk.api_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost:8086
# See configuration.py for a list of all supported configuration parameters.
configuration = pldpro_sdk.api_client.Configuration(
    host = "http://localhost:8086"
)

# 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: 1_tenant
configuration.api_key['1_tenant'] = os.environ["API_KEY"]

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

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

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

# Configure Bearer authorization (JWT): security_auth
configuration = pldpro_sdk.api_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

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

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

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

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

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

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

# Enter a context with an instance of the API client
with pldpro_sdk.api_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pldpro_sdk.api_client.AuthNodesApi(api_client)
    uuid = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | Identificador único do AuthNode cujas versões do PLDPro serão listadas.

    try:
        # Lista as versões disponíveis do PLDPro para um AuthNode
        api_response = api_instance.get_versoes_container(uuid)
        print("The response of AuthNodesApi->get_versoes_container:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AuthNodesApi->get_versoes_container: %s\n" % e)

Parameters

Name	Type	Description	Notes
uuid	UUID	Identificador único do AuthNode cujas versões do PLDPro serão listadas.

Return type

List[str]

Authorization

1_tenant, 4_roles, security_auth, 2_user, ApiKeyAuth, 3_user_id

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Lista de versões do PLDPro encontradas para o AuthNode e seu node remoto.	-
404	AuthNode não encontrado.	-
400	Erro ao consultar as versões do PLDPro.	-

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

list_auth_nodes

List[AuthNodeResponseDTO] list_auth_nodes()

Lista AuthNodes

Retorna todos os AuthNodes compartilhados visíveis para o solicitante.

Example

• Api Key Authentication (1_tenant):
• Api Key Authentication (4_roles):
• Bearer (JWT) Authentication (security_auth):
• Api Key Authentication (2_user):
• Api Key Authentication (ApiKeyAuth):
• Api Key Authentication (3_user_id):

import pldpro_sdk.api_client
from pldpro_sdk.api_client.models.auth_node_response_dto import AuthNodeResponseDTO
from pldpro_sdk.api_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost:8086
# See configuration.py for a list of all supported configuration parameters.
configuration = pldpro_sdk.api_client.Configuration(
    host = "http://localhost:8086"
)

# 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: 1_tenant
configuration.api_key['1_tenant'] = os.environ["API_KEY"]

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

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

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

# Configure Bearer authorization (JWT): security_auth
configuration = pldpro_sdk.api_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

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

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

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

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

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

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

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

    try:
        # Lista AuthNodes
        api_response = api_instance.list_auth_nodes()
        print("The response of AuthNodesApi->list_auth_nodes:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AuthNodesApi->list_auth_nodes: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

List[AuthNodeResponseDTO]

Authorization

1_tenant, 4_roles, security_auth, 2_user, ApiKeyAuth, 3_user_id

HTTP request headers

• Content-Type: Not defined
• Accept: /

HTTP response details

Status code	Description	Response headers
200	AuthNodes retornados com sucesso.	-

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

list_current_user_auth_nodes

List[AuthNodeResponseDTO] list_current_user_auth_nodes()

Lista AuthNodes do usuário autenticado

Retorna os AuthNodes associados ao usuário autenticado.

Example

• Api Key Authentication (1_tenant):
• Api Key Authentication (4_roles):
• Bearer (JWT) Authentication (security_auth):
• Api Key Authentication (2_user):
• Api Key Authentication (ApiKeyAuth):
• Api Key Authentication (3_user_id):

import pldpro_sdk.api_client
from pldpro_sdk.api_client.models.auth_node_response_dto import AuthNodeResponseDTO
from pldpro_sdk.api_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost:8086
# See configuration.py for a list of all supported configuration parameters.
configuration = pldpro_sdk.api_client.Configuration(
    host = "http://localhost:8086"
)

# 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: 1_tenant
configuration.api_key['1_tenant'] = os.environ["API_KEY"]

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

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

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

# Configure Bearer authorization (JWT): security_auth
configuration = pldpro_sdk.api_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

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

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

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

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

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

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

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

    try:
        # Lista AuthNodes do usuário autenticado
        api_response = api_instance.list_current_user_auth_nodes()
        print("The response of AuthNodesApi->list_current_user_auth_nodes:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AuthNodesApi->list_current_user_auth_nodes: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

List[AuthNodeResponseDTO]

Authorization

1_tenant, 4_roles, security_auth, 2_user, ApiKeyAuth, 3_user_id

HTTP request headers

• Content-Type: Not defined
• Accept: /

HTTP response details

Status code	Description	Response headers
200	AuthNodes retornados com sucesso.	-

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

list_executions_by_auth_node

List[ExecutionStatus] list_executions_by_auth_node(uuid)

Lista o status das execuções associadas a um AuthNode

Retorna a lista de execuções vinculadas aos casos associados ao AuthNode identificado pelo UUID informado.

Cada item contém o identificador do caso, informações de caminho e o status atual da execução.

Example

• Api Key Authentication (1_tenant):
• Api Key Authentication (4_roles):
• Bearer (JWT) Authentication (security_auth):
• Api Key Authentication (2_user):
• Api Key Authentication (ApiKeyAuth):
• Api Key Authentication (3_user_id):

import pldpro_sdk.api_client
from pldpro_sdk.api_client.models.execution_status import ExecutionStatus
from pldpro_sdk.api_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost:8086
# See configuration.py for a list of all supported configuration parameters.
configuration = pldpro_sdk.api_client.Configuration(
    host = "http://localhost:8086"
)

# 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: 1_tenant
configuration.api_key['1_tenant'] = os.environ["API_KEY"]

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

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

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

# Configure Bearer authorization (JWT): security_auth
configuration = pldpro_sdk.api_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

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

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

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

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

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

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

# Enter a context with an instance of the API client
with pldpro_sdk.api_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pldpro_sdk.api_client.AuthNodesApi(api_client)
    uuid = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | Identificador único do AuthNode cujas execuções serão listadas.

    try:
        # Lista o status das execuções associadas a um AuthNode
        api_response = api_instance.list_executions_by_auth_node(uuid)
        print("The response of AuthNodesApi->list_executions_by_auth_node:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AuthNodesApi->list_executions_by_auth_node: %s\n" % e)

Parameters

Name	Type	Description	Notes
uuid	UUID	Identificador único do AuthNode cujas execuções serão listadas.

Return type

List[ExecutionStatus]

Authorization

1_tenant, 4_roles, security_auth, 2_user, ApiKeyAuth, 3_user_id

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Lista de execuções associadas ao AuthNode.	-
404	AuthNode não encontrado para o UUID informado.	-
400	Erro ao consultar as execuções do AuthNode.	-

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

list_user_auth_nodes

List[AuthNodeResponseDTO] list_user_auth_nodes(user_uuid)

Lista AuthNodes de um usuário

Retorna os AuthNodes associados ao UUID de usuário informado.

Example

• Api Key Authentication (1_tenant):
• Api Key Authentication (4_roles):
• Bearer (JWT) Authentication (security_auth):
• Api Key Authentication (2_user):
• Api Key Authentication (ApiKeyAuth):
• Api Key Authentication (3_user_id):

import pldpro_sdk.api_client
from pldpro_sdk.api_client.models.auth_node_response_dto import AuthNodeResponseDTO
from pldpro_sdk.api_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost:8086
# See configuration.py for a list of all supported configuration parameters.
configuration = pldpro_sdk.api_client.Configuration(
    host = "http://localhost:8086"
)

# 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: 1_tenant
configuration.api_key['1_tenant'] = os.environ["API_KEY"]

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

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

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

# Configure Bearer authorization (JWT): security_auth
configuration = pldpro_sdk.api_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

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

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

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

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

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

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

# Enter a context with an instance of the API client
with pldpro_sdk.api_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pldpro_sdk.api_client.AuthNodesApi(api_client)
    user_uuid = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | 

    try:
        # Lista AuthNodes de um usuário
        api_response = api_instance.list_user_auth_nodes(user_uuid)
        print("The response of AuthNodesApi->list_user_auth_nodes:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AuthNodesApi->list_user_auth_nodes: %s\n" % e)

Parameters

Name	Type	Description	Notes
user_uuid	UUID

Return type

List[AuthNodeResponseDTO]

Authorization

1_tenant, 4_roles, security_auth, 2_user, ApiKeyAuth, 3_user_id

HTTP request headers

• Content-Type: Not defined
• Accept: /

HTTP response details

Status code	Description	Response headers
200	AuthNodes retornados com sucesso.	-

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

provision_managed_ssh_auth_node_public_key

provision_managed_ssh_auth_node_public_key(uuid)

Instala a chave pública SSH gerenciada

Usa a senha armazenada no AuthNode para instalar a chave pública do sistema no host remoto. A operação é idempotente: a chave só é adicionada em authorized_keys quando ainda não estiver presente.

Example

• Api Key Authentication (1_tenant):
• Api Key Authentication (4_roles):
• Bearer (JWT) Authentication (security_auth):
• Api Key Authentication (2_user):
• Api Key Authentication (ApiKeyAuth):
• Api Key Authentication (3_user_id):

import pldpro_sdk.api_client
from pldpro_sdk.api_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost:8086
# See configuration.py for a list of all supported configuration parameters.
configuration = pldpro_sdk.api_client.Configuration(
    host = "http://localhost:8086"
)

# 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: 1_tenant
configuration.api_key['1_tenant'] = os.environ["API_KEY"]

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

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

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

# Configure Bearer authorization (JWT): security_auth
configuration = pldpro_sdk.api_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

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

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

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

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

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

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

# Enter a context with an instance of the API client
with pldpro_sdk.api_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pldpro_sdk.api_client.AuthNodesApi(api_client)
    uuid = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | 

    try:
        # Instala a chave pública SSH gerenciada
        api_instance.provision_managed_ssh_auth_node_public_key(uuid)
    except Exception as e:
        print("Exception when calling AuthNodesApi->provision_managed_ssh_auth_node_public_key: %s\n" % e)

Parameters

Name	Type	Description	Notes
uuid	UUID

Return type

void (empty response body)

Authorization

1_tenant, 4_roles, security_auth, 2_user, ApiKeyAuth, 3_user_id

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

HTTP response details

Status code	Description	Response headers
204	Chave pública instalada com sucesso.	-
400	Senha não configurada.	-
502	Não foi possível conectar ao host remoto.	-

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

rotate_managed_ssh_auth_node_key_pair

AuthNodeSshPublicKeyResponseDTO rotate_managed_ssh_auth_node_key_pair(uuid, auth_node_ssh_key_rotation_request_dto)

Rotaciona o par de chaves SSH gerenciado

Instala a nova chave pública no host remoto antes de substituir a chave privada persistida. Assim, uma falha de conexão não substitui a chave atualmente utilizável.

Example

• Api Key Authentication (1_tenant):
• Api Key Authentication (4_roles):
• Bearer (JWT) Authentication (security_auth):
• Api Key Authentication (2_user):
• Api Key Authentication (ApiKeyAuth):
• Api Key Authentication (3_user_id):

import pldpro_sdk.api_client
from pldpro_sdk.api_client.models.auth_node_ssh_key_rotation_request_dto import AuthNodeSshKeyRotationRequestDTO
from pldpro_sdk.api_client.models.auth_node_ssh_public_key_response_dto import AuthNodeSshPublicKeyResponseDTO
from pldpro_sdk.api_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost:8086
# See configuration.py for a list of all supported configuration parameters.
configuration = pldpro_sdk.api_client.Configuration(
    host = "http://localhost:8086"
)

# 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: 1_tenant
configuration.api_key['1_tenant'] = os.environ["API_KEY"]

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

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

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

# Configure Bearer authorization (JWT): security_auth
configuration = pldpro_sdk.api_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

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

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

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

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

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

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

# Enter a context with an instance of the API client
with pldpro_sdk.api_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pldpro_sdk.api_client.AuthNodesApi(api_client)
    uuid = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | 
    auth_node_ssh_key_rotation_request_dto = pldpro_sdk.api_client.AuthNodeSshKeyRotationRequestDTO() # AuthNodeSshKeyRotationRequestDTO | 

    try:
        # Rotaciona o par de chaves SSH gerenciado
        api_response = api_instance.rotate_managed_ssh_auth_node_key_pair(uuid, auth_node_ssh_key_rotation_request_dto)
        print("The response of AuthNodesApi->rotate_managed_ssh_auth_node_key_pair:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AuthNodesApi->rotate_managed_ssh_auth_node_key_pair: %s\n" % e)

Parameters

Name	Type	Description	Notes
uuid	UUID
auth_node_ssh_key_rotation_request_dto	AuthNodeSshKeyRotationRequestDTO

Return type

AuthNodeSshPublicKeyResponseDTO

Authorization

1_tenant, 4_roles, security_auth, 2_user, ApiKeyAuth, 3_user_id

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	Par de chaves rotacionado com sucesso.	-
400	Senha inválida.	-
502	Não foi possível conectar ao host remoto.	-

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

update_auth_node

AuthNodeResponseDTO update_auth_node(uuid, auth_node_update_dto)

Atualiza um AuthNode

Atualiza o AuthNode compartilhado identificado pelo UUID.

Example

• Api Key Authentication (1_tenant):
• Api Key Authentication (4_roles):
• Bearer (JWT) Authentication (security_auth):
• Api Key Authentication (2_user):
• Api Key Authentication (ApiKeyAuth):
• Api Key Authentication (3_user_id):

import pldpro_sdk.api_client
from pldpro_sdk.api_client.models.auth_node_response_dto import AuthNodeResponseDTO
from pldpro_sdk.api_client.models.auth_node_update_dto import AuthNodeUpdateDTO
from pldpro_sdk.api_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost:8086
# See configuration.py for a list of all supported configuration parameters.
configuration = pldpro_sdk.api_client.Configuration(
    host = "http://localhost:8086"
)

# 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: 1_tenant
configuration.api_key['1_tenant'] = os.environ["API_KEY"]

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

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

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

# Configure Bearer authorization (JWT): security_auth
configuration = pldpro_sdk.api_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

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

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

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

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

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

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

# Enter a context with an instance of the API client
with pldpro_sdk.api_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pldpro_sdk.api_client.AuthNodesApi(api_client)
    uuid = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | 
    auth_node_update_dto = pldpro_sdk.api_client.AuthNodeUpdateDTO() # AuthNodeUpdateDTO | 

    try:
        # Atualiza um AuthNode
        api_response = api_instance.update_auth_node(uuid, auth_node_update_dto)
        print("The response of AuthNodesApi->update_auth_node:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AuthNodesApi->update_auth_node: %s\n" % e)

Parameters

Name	Type	Description	Notes
uuid	UUID
auth_node_update_dto	AuthNodeUpdateDTO

Return type

AuthNodeResponseDTO

Authorization

1_tenant, 4_roles, security_auth, 2_user, ApiKeyAuth, 3_user_id

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	AuthNode atualizado com sucesso.	-
404	AuthNode não encontrado.	-

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

update_auth_nodes_batch

List[AuthNodeResponseDTO] update_auth_nodes_batch(auth_node_update_dto)

Atualiza AuthNodes em lote

Aplica atualizações genéricas de AuthNode para cada item da lista enviada.

Example

• Api Key Authentication (1_tenant):
• Api Key Authentication (4_roles):
• Bearer (JWT) Authentication (security_auth):
• Api Key Authentication (2_user):
• Api Key Authentication (ApiKeyAuth):
• Api Key Authentication (3_user_id):

import pldpro_sdk.api_client
from pldpro_sdk.api_client.models.auth_node_response_dto import AuthNodeResponseDTO
from pldpro_sdk.api_client.models.auth_node_update_dto import AuthNodeUpdateDTO
from pldpro_sdk.api_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost:8086
# See configuration.py for a list of all supported configuration parameters.
configuration = pldpro_sdk.api_client.Configuration(
    host = "http://localhost:8086"
)

# 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: 1_tenant
configuration.api_key['1_tenant'] = os.environ["API_KEY"]

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

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

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

# Configure Bearer authorization (JWT): security_auth
configuration = pldpro_sdk.api_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

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

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

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

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

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

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

# Enter a context with an instance of the API client
with pldpro_sdk.api_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pldpro_sdk.api_client.AuthNodesApi(api_client)
    auth_node_update_dto = [pldpro_sdk.api_client.AuthNodeUpdateDTO()] # List[AuthNodeUpdateDTO] | 

    try:
        # Atualiza AuthNodes em lote
        api_response = api_instance.update_auth_nodes_batch(auth_node_update_dto)
        print("The response of AuthNodesApi->update_auth_nodes_batch:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AuthNodesApi->update_auth_nodes_batch: %s\n" % e)

Parameters

Name	Type	Description	Notes
auth_node_update_dto	List[AuthNodeUpdateDTO]

Return type

List[AuthNodeResponseDTO]

Authorization

1_tenant, 4_roles, security_auth, 2_user, ApiKeyAuth, 3_user_id

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	AuthNodes atualizados com sucesso.	-

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

update_current_user_auth_node_access

AuthNodeResponseDTO update_current_user_auth_node_access(auth_node_user_update_dto)

Atualiza o acesso AuthNode do usuário autenticado

Cria ou atualiza o acesso do usuário autenticado a um Node.

Example

• Api Key Authentication (1_tenant):
• Api Key Authentication (4_roles):
• Bearer (JWT) Authentication (security_auth):
• Api Key Authentication (2_user):
• Api Key Authentication (ApiKeyAuth):
• Api Key Authentication (3_user_id):

import pldpro_sdk.api_client
from pldpro_sdk.api_client.models.auth_node_response_dto import AuthNodeResponseDTO
from pldpro_sdk.api_client.models.auth_node_user_update_dto import AuthNodeUserUpdateDTO
from pldpro_sdk.api_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost:8086
# See configuration.py for a list of all supported configuration parameters.
configuration = pldpro_sdk.api_client.Configuration(
    host = "http://localhost:8086"
)

# 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: 1_tenant
configuration.api_key['1_tenant'] = os.environ["API_KEY"]

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

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

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

# Configure Bearer authorization (JWT): security_auth
configuration = pldpro_sdk.api_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

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

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

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

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

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

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

# Enter a context with an instance of the API client
with pldpro_sdk.api_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pldpro_sdk.api_client.AuthNodesApi(api_client)
    auth_node_user_update_dto = pldpro_sdk.api_client.AuthNodeUserUpdateDTO() # AuthNodeUserUpdateDTO | 

    try:
        # Atualiza o acesso AuthNode do usuário autenticado
        api_response = api_instance.update_current_user_auth_node_access(auth_node_user_update_dto)
        print("The response of AuthNodesApi->update_current_user_auth_node_access:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AuthNodesApi->update_current_user_auth_node_access: %s\n" % e)

Parameters

Name	Type	Description	Notes
auth_node_user_update_dto	AuthNodeUserUpdateDTO

Return type

AuthNodeResponseDTO

Authorization

1_tenant, 4_roles, security_auth, 2_user, ApiKeyAuth, 3_user_id

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	Acesso AuthNode do usuário autenticado atualizado com sucesso.	-

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