harness_python_sdk.AccountSecretApi

All URIs are relative to https://app.harness.io

Method	HTTP request	Description
create_account_scoped_secret	POST /v1/secrets	Create a secret
delete_account_scoped_secret	DELETE /v1/secrets/{secret}	Deletes a secret
get_account_scoped_secret	GET /v1/secrets/{secret}	Retrieve a secret
get_account_scoped_secrets	GET /v1/secrets	List secrets
update_account_scoped_secret	PUT /v1/secrets/{secret}	Update a secret
validate_account_secret_ref	POST /v1/secrets/validate-secret-ref	Validate secret reference

create_account_scoped_secret

SecretResponse create_account_scoped_secret(body, harness_account=harness_account, private_secret=private_secret)

Create a secret

Creates a new secret

Example

from __future__ import print_function
import time
import harness_python_sdk
from harness_python_sdk.rest import ApiException
from pprint import pprint

# Configure API key authorization: x-api-key
configuration = harness_python_sdk.Configuration()
configuration.api_key['x-api-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['x-api-key'] = 'Bearer'

# create an instance of the API class
api_instance = harness_python_sdk.AccountSecretApi(harness_python_sdk.ApiClient(configuration))
body = harness_python_sdk.SecretRequest() # SecretRequest | 
harness_account = 'harness_account_example' # str | Identifier field of the account the resource is scoped to. This is required for Authorization methods other than the x-api-key header. If you are using the x-api-key header, this can be skipped. (optional)
private_secret = false # bool | This would be used to define secret as private. (optional) (default to false)

try:
    # Create a secret
    api_response = api_instance.create_account_scoped_secret(body, harness_account=harness_account, private_secret=private_secret)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AccountSecretApi->create_account_scoped_secret: %s\n" % e)

Parameters

Name	Type	Description	Notes
body	SecretRequest
harness_account	str	Identifier field of the account the resource is scoped to. This is required for Authorization methods other than the x-api-key header. If you are using the x-api-key header, this can be skipped.	[optional]
private_secret	bool	This would be used to define secret as private.	[optional] [default to false]

Return type

SecretResponse

Authorization

x-api-key

HTTP request headers

Content-Type: application/json, application/yaml, multipart/form-data
Accept: application/json, application/yaml

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

delete_account_scoped_secret

SecretResponse delete_account_scoped_secret(secret, harness_account=harness_account)

Deletes a secret

Deletes the information of the secret with the matching secret identifier.

Example

from __future__ import print_function
import time
import harness_python_sdk
from harness_python_sdk.rest import ApiException
from pprint import pprint

# Configure API key authorization: x-api-key
configuration = harness_python_sdk.Configuration()
configuration.api_key['x-api-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['x-api-key'] = 'Bearer'

# create an instance of the API class
api_instance = harness_python_sdk.AccountSecretApi(harness_python_sdk.ApiClient(configuration))
secret = 'secret_example' # str | Identifier field of the secret
harness_account = 'harness_account_example' # str | Identifier field of the account the resource is scoped to. This is required for Authorization methods other than the x-api-key header. If you are using the x-api-key header, this can be skipped. (optional)

try:
    # Deletes a secret
    api_response = api_instance.delete_account_scoped_secret(secret, harness_account=harness_account)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AccountSecretApi->delete_account_scoped_secret: %s\n" % e)

Parameters

Name	Type	Description	Notes
secret	str	Identifier field of the secret
harness_account	str	Identifier field of the account the resource is scoped to. This is required for Authorization methods other than the x-api-key header. If you are using the x-api-key header, this can be skipped.	[optional]

Return type

SecretResponse

Authorization

x-api-key

HTTP request headers

Content-Type: Not defined
Accept: application/json, application/yaml

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

get_account_scoped_secret

SecretResponse get_account_scoped_secret(secret, harness_account=harness_account)

Retrieve a secret

Retrieves the information of the secret.

Example

from __future__ import print_function
import time
import harness_python_sdk
from harness_python_sdk.rest import ApiException
from pprint import pprint

# Configure API key authorization: x-api-key
configuration = harness_python_sdk.Configuration()
configuration.api_key['x-api-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['x-api-key'] = 'Bearer'

# create an instance of the API class
api_instance = harness_python_sdk.AccountSecretApi(harness_python_sdk.ApiClient(configuration))
secret = 'secret_example' # str | Identifier field of the secret
harness_account = 'harness_account_example' # str | Identifier field of the account the resource is scoped to. This is required for Authorization methods other than the x-api-key header. If you are using the x-api-key header, this can be skipped. (optional)

try:
    # Retrieve a secret
    api_response = api_instance.get_account_scoped_secret(secret, harness_account=harness_account)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AccountSecretApi->get_account_scoped_secret: %s\n" % e)

Parameters

Name	Type	Description	Notes
secret	str	Identifier field of the secret
harness_account	str	Identifier field of the account the resource is scoped to. This is required for Authorization methods other than the x-api-key header. If you are using the x-api-key header, this can be skipped.	[optional]

Return type

SecretResponse

Authorization

x-api-key

HTTP request headers

Content-Type: Not defined
Accept: application/json, application/yaml

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

get_account_scoped_secrets

list[SecretResponse] get_account_scoped_secrets(secret=secret, type=type, recursive=recursive, search_term=search_term, page=page, limit=limit, harness_account=harness_account, sort=sort, order=order)

List secrets

Retrieves the information of the secrets.

Example

from __future__ import print_function
import time
import harness_python_sdk
from harness_python_sdk.rest import ApiException
from pprint import pprint

# Configure API key authorization: x-api-key
configuration = harness_python_sdk.Configuration()
configuration.api_key['x-api-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['x-api-key'] = 'Bearer'

# create an instance of the API class
api_instance = harness_python_sdk.AccountSecretApi(harness_python_sdk.ApiClient(configuration))
secret = ['secret_example'] # list[str] | Identifier field of secrets (optional)
type = ['type_example'] # list[str] | Secret types on which the filter will be applied (optional)
recursive = false # bool | Expand current scope to include all child scopes  (optional) (default to false)
search_term = 'search_term_example' # str | This would be used to filter resources having attributes matching with search term. (optional)
page = 0 # int | Pagination page number strategy: Specify the page number within the paginated collection related to the number of items in each page  (optional) (default to 0)
limit = 30 # int | Number of items to return per page. (optional) (default to 30)
harness_account = 'harness_account_example' # str | Identifier field of the account the resource is scoped to. This is required for Authorization methods other than the x-api-key header. If you are using the x-api-key header, this can be skipped. (optional)
sort = 'sort_example' # str | Parameter on the basis of which sorting is done. (optional)
order = 'order_example' # str | Order on the basis of which sorting is done. (optional)

try:
    # List secrets
    api_response = api_instance.get_account_scoped_secrets(secret=secret, type=type, recursive=recursive, search_term=search_term, page=page, limit=limit, harness_account=harness_account, sort=sort, order=order)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AccountSecretApi->get_account_scoped_secrets: %s\n" % e)

Parameters

Name	Type	Description	Notes
secret	list[str]	Identifier field of secrets	[optional]
type	list[str]	Secret types on which the filter will be applied	[optional]
recursive	bool	Expand current scope to include all child scopes	[optional] [default to false]
search_term	str	This would be used to filter resources having attributes matching with search term.	[optional]
page	int	Pagination page number strategy: Specify the page number within the paginated collection related to the number of items in each page	[optional] [default to 0]
limit	int	Number of items to return per page.	[optional] [default to 30]
harness_account	str	Identifier field of the account the resource is scoped to. This is required for Authorization methods other than the x-api-key header. If you are using the x-api-key header, this can be skipped.	[optional]
sort	str	Parameter on the basis of which sorting is done.	[optional]
order	str	Order on the basis of which sorting is done.	[optional]

Return type

list[SecretResponse]

Authorization

x-api-key

HTTP request headers

Content-Type: Not defined
Accept: application/json, application/yaml

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

update_account_scoped_secret

SecretResponse update_account_scoped_secret(body, secret, harness_account=harness_account)

Update a secret

Updates the information of the secret with the matching secret identifier.

Example

from __future__ import print_function
import time
import harness_python_sdk
from harness_python_sdk.rest import ApiException
from pprint import pprint

# Configure API key authorization: x-api-key
configuration = harness_python_sdk.Configuration()
configuration.api_key['x-api-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['x-api-key'] = 'Bearer'

# create an instance of the API class
api_instance = harness_python_sdk.AccountSecretApi(harness_python_sdk.ApiClient(configuration))
body = harness_python_sdk.SecretRequest() # SecretRequest | 
secret = 'secret_example' # str | Identifier field of the secret
harness_account = 'harness_account_example' # str | Identifier field of the account the resource is scoped to. This is required for Authorization methods other than the x-api-key header. If you are using the x-api-key header, this can be skipped. (optional)

try:
    # Update a secret
    api_response = api_instance.update_account_scoped_secret(body, secret, harness_account=harness_account)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AccountSecretApi->update_account_scoped_secret: %s\n" % e)

Parameters

Name	Type	Description	Notes
body	SecretRequest
secret	str	Identifier field of the secret
harness_account	str	Identifier field of the account the resource is scoped to. This is required for Authorization methods other than the x-api-key header. If you are using the x-api-key header, this can be skipped.	[optional]

Return type

SecretResponse

Authorization

x-api-key

HTTP request headers

Content-Type: application/json, application/yaml, multipart/form-data
Accept: application/json, application/yaml

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

validate_account_secret_ref

SecretValidationResponse validate_account_secret_ref(body=body, harness_account=harness_account)

Validate secret reference

Validates if the secret at the secretManager path can be referenced

Example

from __future__ import print_function
import time
import harness_python_sdk
from harness_python_sdk.rest import ApiException
from pprint import pprint

# Configure API key authorization: x-api-key
configuration = harness_python_sdk.Configuration()
configuration.api_key['x-api-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['x-api-key'] = 'Bearer'

# create an instance of the API class
api_instance = harness_python_sdk.AccountSecretApi(harness_python_sdk.ApiClient(configuration))
body = harness_python_sdk.SecretRequest() # SecretRequest | Details of the secret reference (optional)
harness_account = 'harness_account_example' # str | Identifier field of the account the resource is scoped to. This is required for Authorization methods other than the x-api-key header. If you are using the x-api-key header, this can be skipped. (optional)

try:
    # Validate secret reference
    api_response = api_instance.validate_account_secret_ref(body=body, harness_account=harness_account)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AccountSecretApi->validate_account_secret_ref: %s\n" % e)

Parameters

Name	Type	Description	Notes
body	SecretRequest	Details of the secret reference	[optional]
harness_account	str	Identifier field of the account the resource is scoped to. This is required for Authorization methods other than the x-api-key header. If you are using the x-api-key header, this can be skipped.	[optional]

Return type

SecretValidationResponse

Authorization

x-api-key

HTTP request headers

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

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

Files

AccountSecretApi.md

Latest commit

History

AccountSecretApi.md

File metadata and controls

harness_python_sdk.AccountSecretApi

create_account_scoped_secret

Example

Parameters

Return type

Authorization

HTTP request headers

delete_account_scoped_secret

Example

Parameters

Return type

Authorization

HTTP request headers

get_account_scoped_secret

Example

Parameters

Return type

Authorization

HTTP request headers

get_account_scoped_secrets

Example

Parameters

Return type

Authorization

HTTP request headers

update_account_scoped_secret

Example

Parameters

Return type

Authorization

HTTP request headers

validate_account_secret_ref

Example

Parameters

Return type

Authorization

HTTP request headers