GetAccessCredentials

Using GetAccessCredentials

function getAccessCredentials(args: GetAccessCredentialsArgs, opts?: InvokeOptions): Promise<GetAccessCredentialsResult>

function  get_access_credentials(backend=None, max_cred_validation_seconds=None, num_seconds_between_tests=None, num_sequential_successes=None, role=None, validate_creds=None, opts=None)

func GetAccessCredentials(ctx *Context, args *GetAccessCredentialsArgs, opts ...InvokeOption) (*GetAccessCredentialsResult, error)

public static class GetAccessCredentials {
    public static Task<GetAccessCredentialsResult> InvokeAsync(GetAccessCredentialsArgs args, InvokeOptions? opts = null)
}

The following arguments are supported:

Backend string: The path to the Azure secret backend to read credentials from, with no leading or trailing /s.
Role string: The name of the Azure secret backend role to read credentials from, with no leading or trailing /s.
MaxCredValidationSeconds int: If ‘validate_creds’ is true, the number of seconds after which to give up validating credentials. Defaults to 1,200 (20 minutes).
NumSecondsBetweenTests int: If ‘validate_creds’ is true, the number of seconds to wait between each test of generated credentials. Defaults to 7.
NumSequentialSuccesses int: If ‘validate_creds’ is true, the number of sequential successes required to validate generated credentials. Defaults to 8.
ValidateCreds bool: Whether generated credentials should be validated before being returned. Defaults to false, which returns credentials without checking whether they have fully propagated throughout Azure Active Directory. Designating true activates testing.

Backend string: The path to the Azure secret backend to read credentials from, with no leading or trailing /s.
Role string: The name of the Azure secret backend role to read credentials from, with no leading or trailing /s.
MaxCredValidationSeconds int: If ‘validate_creds’ is true, the number of seconds after which to give up validating credentials. Defaults to 1,200 (20 minutes).
NumSecondsBetweenTests int: If ‘validate_creds’ is true, the number of seconds to wait between each test of generated credentials. Defaults to 7.
NumSequentialSuccesses int: If ‘validate_creds’ is true, the number of sequential successes required to validate generated credentials. Defaults to 8.
ValidateCreds bool: Whether generated credentials should be validated before being returned. Defaults to false, which returns credentials without checking whether they have fully propagated throughout Azure Active Directory. Designating true activates testing.

backend string: The path to the Azure secret backend to read credentials from, with no leading or trailing /s.
role string: The name of the Azure secret backend role to read credentials from, with no leading or trailing /s.
maxCredValidationSeconds number: If ‘validate_creds’ is true, the number of seconds after which to give up validating credentials. Defaults to 1,200 (20 minutes).
numSecondsBetweenTests number: If ‘validate_creds’ is true, the number of seconds to wait between each test of generated credentials. Defaults to 7.
numSequentialSuccesses number: If ‘validate_creds’ is true, the number of sequential successes required to validate generated credentials. Defaults to 8.
validateCreds boolean: Whether generated credentials should be validated before being returned. Defaults to false, which returns credentials without checking whether they have fully propagated throughout Azure Active Directory. Designating true activates testing.

backend str: The path to the Azure secret backend to read credentials from, with no leading or trailing /s.
role str: The name of the Azure secret backend role to read credentials from, with no leading or trailing /s.
max_cred_validation_seconds float: If ‘validate_creds’ is true, the number of seconds after which to give up validating credentials. Defaults to 1,200 (20 minutes).
num_seconds_between_tests float: If ‘validate_creds’ is true, the number of seconds to wait between each test of generated credentials. Defaults to 7.
num_sequential_successes float: If ‘validate_creds’ is true, the number of sequential successes required to validate generated credentials. Defaults to 8.
validate_creds bool: Whether generated credentials should be validated before being returned. Defaults to false, which returns credentials without checking whether they have fully propagated throughout Azure Active Directory. Designating true activates testing.

GetAccessCredentials Result

The following output properties are available:

Backend string
ClientId string: The client id for credentials to query the Azure APIs.
ClientSecret string: The client secret for credentials to query the Azure APIs.
Id string: The provider-assigned unique ID for this managed resource.
LeaseDuration int: The duration of the secret lease, in seconds relative to the time the data was requested. Once this time has passed any plan generated with this data may fail to apply.
LeaseId string: The lease identifier assigned by Vault.
LeaseRenewable bool
LeaseStartTime string
Role string
MaxCredValidationSeconds int
NumSecondsBetweenTests int
NumSequentialSuccesses int
ValidateCreds bool

Backend string
ClientId string: The client id for credentials to query the Azure APIs.
ClientSecret string: The client secret for credentials to query the Azure APIs.
Id string: The provider-assigned unique ID for this managed resource.
LeaseDuration int: The duration of the secret lease, in seconds relative to the time the data was requested. Once this time has passed any plan generated with this data may fail to apply.
LeaseId string: The lease identifier assigned by Vault.
LeaseRenewable bool
LeaseStartTime string
Role string
MaxCredValidationSeconds int
NumSecondsBetweenTests int
NumSequentialSuccesses int
ValidateCreds bool

backend string
clientId string: The client id for credentials to query the Azure APIs.
clientSecret string: The client secret for credentials to query the Azure APIs.
id string: The provider-assigned unique ID for this managed resource.
leaseDuration number: The duration of the secret lease, in seconds relative to the time the data was requested. Once this time has passed any plan generated with this data may fail to apply.
leaseId string: The lease identifier assigned by Vault.
leaseRenewable boolean
leaseStartTime string
role string
maxCredValidationSeconds number
numSecondsBetweenTests number
numSequentialSuccesses number
validateCreds boolean

backend str
client_id str: The client id for credentials to query the Azure APIs.
client_secret str: The client secret for credentials to query the Azure APIs.
id str: The provider-assigned unique ID for this managed resource.
lease_duration float: The duration of the secret lease, in seconds relative to the time the data was requested. Once this time has passed any plan generated with this data may fail to apply.
lease_id str: The lease identifier assigned by Vault.
lease_renewable bool
lease_start_time str
role str
max_cred_validation_seconds float
num_seconds_between_tests float
num_sequential_successes float
validate_creds bool

Package Details

Repository: https://github.com/pulumi/pulumi-vault
License: Apache-2.0
Notes: This Pulumi package is based on the vault Terraform Provider.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud

GetAccessCredentials

Using GetAccessCredentials

GetAccessCredentials Result

Package Details

On This Page