Skip to content

shared_credentials

Shared credentials management for managing credentials that are stored in the shared .credentials folder in the DQOps user's home folder.

create_shared_credential

Creates (adds) a new shared credential, which creates a file in the DQOps user's home .credentials/ folder named as the credential and with the content that is provided in this call.
Source code

POST 

http://localhost:8888/api/credentials

Request body

 Description                       Data type   Required 
Shared credential model SharedCredentialModel

Usage examples 

curl -X POST http://localhost:8888/api/credentials^
    -H "Accept: application/json"^
    -H "Content-Type: application/json"^
    -d^
    "{\"credential_name\":\"sample_credential\",\"type\":\"text\",\"text_value\":\"sample_credential_text_value\"}"

delete_shared_credential

Deletes a shared credential file from the DQOps user's home .credentials/ folder.
Source code

DELETE 

http://localhost:8888/api/credentials/{credentialName}

Parameters of this method are described below

 Property name   Description                       Data type   Required 
credential_name Full shared credential name string

Usage examples 

curl -X DELETE http://localhost:8888/api/credentials/sample_credential^
    -H "Accept: application/json"

download_shared_credential

Downloads a shared credential's file
Source code

GET 

http://localhost:8888/api/credentials/{credentialName}/download

Parameters of this method are described below

 Property name   Description                       Data type   Required 
credential_name Shared credential file name string

Usage examples 

curl http://localhost:8888/api/credentials/sample_credential/download^
    -H "Accept: application/json"

get_all_shared_credentials

Returns a list of all shared credentials that are present in the DQOps user's home .credentials/ folder..
Source code

GET 

http://localhost:8888/api/credentials

Return value

 Property name   Description                       Data type 
shared_credential_list_model List[SharedCredentialListModel]

Usage examples 

curl http://localhost:8888/api/credentials^
    -H "Accept: application/json"

get_shared_credential

Returns a shared credential content
Source code

GET 

http://localhost:8888/api/credentials/{credentialName}

Return value

 Property name   Description                       Data type 
shared_credential_model SharedCredentialModel

Parameters of this method are described below

 Property name   Description                       Data type   Required 
credential_name Shared credential file name string

Usage examples 

curl http://localhost:8888/api/credentials/sample_credential^
    -H "Accept: application/json"

update_shared_credential

Updates an existing shared credential, replacing the credential's file content.
Source code

PUT 

http://localhost:8888/api/credential/{credentialName}

Parameters of this method are described below

 Property name   Description                       Data type   Required 
credential_name Credential file name that will be updated string

Request body

 Description                       Data type   Required 
Shared credential model SharedCredentialModel

Usage examples 

curl -X PUT http://localhost:8888/api/credential/sample_credential^
    -H "Accept: application/json"^
    -H "Content-Type: application/json"^
    -d^
    "{\"credential_name\":\"sample_credential\",\"type\":\"text\",\"text_value\":\"sample_credential_text_value\"}"