Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Akeyless Provider
  3. API Docs
  4. getAuth
akeyless 1.9.0 published on Monday, Apr 14, 2025 by akeyless-community
akeyless-community/terraform-provider-akeyless

akeyless.getAuth

Explore with Pulumi AI

akeyless logo
akeyless 1.9.0 published on Monday, Apr 14, 2025 by akeyless-community
akeyless-community/terraform-provider-akeyless

    Authenticate to Akeyless and returns a token to be used by the provider

    Using getAuth

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getAuth(args: GetAuthArgs, opts?: InvokeOptions): Promise<GetAuthResult>
function getAuthOutput(args: GetAuthOutputArgs, opts?: InvokeOptions): Output<GetAuthResult>
    def get_auth(api_key_logins: Optional[Sequence[GetAuthApiKeyLogin]] = None,
             aws_iam_logins: Optional[Sequence[GetAuthAwsIamLogin]] = None,
             azure_ad_logins: Optional[Sequence[GetAuthAzureAdLogin]] = None,
             cert_logins: Optional[Sequence[GetAuthCertLogin]] = None,
             email_logins: Optional[Sequence[GetAuthEmailLogin]] = None,
             gcp_logins: Optional[Sequence[GetAuthGcpLogin]] = None,
             id: Optional[str] = None,
             jwt_logins: Optional[Sequence[GetAuthJwtLogin]] = None,
             uid_logins: Optional[Sequence[GetAuthUidLogin]] = None,
             opts: Optional[InvokeOptions] = None) -> GetAuthResult
def get_auth_output(api_key_logins: Optional[pulumi.Input[Sequence[pulumi.Input[GetAuthApiKeyLoginArgs]]]] = None,
             aws_iam_logins: Optional[pulumi.Input[Sequence[pulumi.Input[GetAuthAwsIamLoginArgs]]]] = None,
             azure_ad_logins: Optional[pulumi.Input[Sequence[pulumi.Input[GetAuthAzureAdLoginArgs]]]] = None,
             cert_logins: Optional[pulumi.Input[Sequence[pulumi.Input[GetAuthCertLoginArgs]]]] = None,
             email_logins: Optional[pulumi.Input[Sequence[pulumi.Input[GetAuthEmailLoginArgs]]]] = None,
             gcp_logins: Optional[pulumi.Input[Sequence[pulumi.Input[GetAuthGcpLoginArgs]]]] = None,
             id: Optional[pulumi.Input[str]] = None,
             jwt_logins: Optional[pulumi.Input[Sequence[pulumi.Input[GetAuthJwtLoginArgs]]]] = None,
             uid_logins: Optional[pulumi.Input[Sequence[pulumi.Input[GetAuthUidLoginArgs]]]] = None,
             opts: Optional[InvokeOptions] = None) -> Output[GetAuthResult]
    func GetAuth(ctx *Context, args *GetAuthArgs, opts ...InvokeOption) (*GetAuthResult, error)
func GetAuthOutput(ctx *Context, args *GetAuthOutputArgs, opts ...InvokeOption) GetAuthResultOutput

    > Note: This function is named GetAuth in the Go SDK.

    public static class GetAuth 
{
    public static Task<GetAuthResult> InvokeAsync(GetAuthArgs args, InvokeOptions? opts = null)
    public static Output<GetAuthResult> Invoke(GetAuthInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetAuthResult> getAuth(GetAuthArgs args, InvokeOptions options)
public static Output<GetAuthResult> getAuth(GetAuthArgs args, InvokeOptions options)

    fn::invoke:
  function: akeyless:index/getAuth:getAuth
  arguments:
    # arguments dictionary

    The following arguments are supported:

    ApiKeyLogins List<GetAuthApiKeyLogin>
    A configuration block, described below, that attempts to authenticate using API-Key.
    AwsIamLogins List<GetAuthAwsIamLogin>
    A configuration block, described below, that attempts to authenticate using AWS-IAM authentication credentials.
    AzureAdLogins List<GetAuthAzureAdLogin>
    A configuration block, described below, that attempts to authenticate using Azure Active Directory authentication.
    CertLogins List<GetAuthCertLogin>
    A configuration block, described below, that attempts to authenticate using Certificate authentication. The Certificate and the Private key can be provided as a command line variable or it will be pulled out of an environment variable named AKEYLESSAUTHCERT and AKEYLESSAUTHKEY.
    EmailLogins List<GetAuthEmailLogin>
    A configuration block, described below, that attempts to authenticate using email and password.
    GcpLogins List<GetAuthGcpLogin>
    A configuration block, described below, that attempts to authenticate using GCP-IAM authentication credentials.
    Id string
    The ID of this resource.
    JwtLogins List<GetAuthJwtLogin>
    A configuration block, described below, that attempts to authenticate using JWT authentication. The JWT can be provided as a command line variable or it will be pulled out of an environment variable named AKEYLESSAUTHJWT.
    UidLogins List<GetAuthUidLogin>
    A configuration block, described below, that attempts to authenticate using Universal Identity authentication.
    ApiKeyLogins []GetAuthApiKeyLogin
    A configuration block, described below, that attempts to authenticate using API-Key.
    AwsIamLogins []GetAuthAwsIamLogin
    A configuration block, described below, that attempts to authenticate using AWS-IAM authentication credentials.
    AzureAdLogins []GetAuthAzureAdLogin
    A configuration block, described below, that attempts to authenticate using Azure Active Directory authentication.
    CertLogins []GetAuthCertLogin
    A configuration block, described below, that attempts to authenticate using Certificate authentication. The Certificate and the Private key can be provided as a command line variable or it will be pulled out of an environment variable named AKEYLESSAUTHCERT and AKEYLESSAUTHKEY.
    EmailLogins []GetAuthEmailLogin
    A configuration block, described below, that attempts to authenticate using email and password.
    GcpLogins []GetAuthGcpLogin
    A configuration block, described below, that attempts to authenticate using GCP-IAM authentication credentials.
    Id string
    The ID of this resource.
    JwtLogins []GetAuthJwtLogin
    A configuration block, described below, that attempts to authenticate using JWT authentication. The JWT can be provided as a command line variable or it will be pulled out of an environment variable named AKEYLESSAUTHJWT.
    UidLogins []GetAuthUidLogin
    A configuration block, described below, that attempts to authenticate using Universal Identity authentication.
    apiKeyLogins List<GetAuthApiKeyLogin>
    A configuration block, described below, that attempts to authenticate using API-Key.
    awsIamLogins List<GetAuthAwsIamLogin>
    A configuration block, described below, that attempts to authenticate using AWS-IAM authentication credentials.
    azureAdLogins List<GetAuthAzureAdLogin>
    A configuration block, described below, that attempts to authenticate using Azure Active Directory authentication.
    certLogins List<GetAuthCertLogin>
    A configuration block, described below, that attempts to authenticate using Certificate authentication. The Certificate and the Private key can be provided as a command line variable or it will be pulled out of an environment variable named AKEYLESSAUTHCERT and AKEYLESSAUTHKEY.
    emailLogins List<GetAuthEmailLogin>
    A configuration block, described below, that attempts to authenticate using email and password.
    gcpLogins List<GetAuthGcpLogin>
    A configuration block, described below, that attempts to authenticate using GCP-IAM authentication credentials.
    id String
    The ID of this resource.
    jwtLogins List<GetAuthJwtLogin>
    A configuration block, described below, that attempts to authenticate using JWT authentication. The JWT can be provided as a command line variable or it will be pulled out of an environment variable named AKEYLESSAUTHJWT.
    uidLogins List<GetAuthUidLogin>
    A configuration block, described below, that attempts to authenticate using Universal Identity authentication.
    apiKeyLogins GetAuthApiKeyLogin[]
    A configuration block, described below, that attempts to authenticate using API-Key.
    awsIamLogins GetAuthAwsIamLogin[]
    A configuration block, described below, that attempts to authenticate using AWS-IAM authentication credentials.
    azureAdLogins GetAuthAzureAdLogin[]
    A configuration block, described below, that attempts to authenticate using Azure Active Directory authentication.
    certLogins GetAuthCertLogin[]
    A configuration block, described below, that attempts to authenticate using Certificate authentication. The Certificate and the Private key can be provided as a command line variable or it will be pulled out of an environment variable named AKEYLESSAUTHCERT and AKEYLESSAUTHKEY.
    emailLogins GetAuthEmailLogin[]
    A configuration block, described below, that attempts to authenticate using email and password.
    gcpLogins GetAuthGcpLogin[]
    A configuration block, described below, that attempts to authenticate using GCP-IAM authentication credentials.
    id string
    The ID of this resource.
    jwtLogins GetAuthJwtLogin[]
    A configuration block, described below, that attempts to authenticate using JWT authentication. The JWT can be provided as a command line variable or it will be pulled out of an environment variable named AKEYLESSAUTHJWT.
    uidLogins GetAuthUidLogin[]
    A configuration block, described below, that attempts to authenticate using Universal Identity authentication.
    api_key_logins Sequence[GetAuthApiKeyLogin]
    A configuration block, described below, that attempts to authenticate using API-Key.
    aws_iam_logins Sequence[GetAuthAwsIamLogin]
    A configuration block, described below, that attempts to authenticate using AWS-IAM authentication credentials.
    azure_ad_logins Sequence[GetAuthAzureAdLogin]
    A configuration block, described below, that attempts to authenticate using Azure Active Directory authentication.
    cert_logins Sequence[GetAuthCertLogin]
    A configuration block, described below, that attempts to authenticate using Certificate authentication. The Certificate and the Private key can be provided as a command line variable or it will be pulled out of an environment variable named AKEYLESSAUTHCERT and AKEYLESSAUTHKEY.
    email_logins Sequence[GetAuthEmailLogin]
    A configuration block, described below, that attempts to authenticate using email and password.
    gcp_logins Sequence[GetAuthGcpLogin]
    A configuration block, described below, that attempts to authenticate using GCP-IAM authentication credentials.
    id str
    The ID of this resource.
    jwt_logins Sequence[GetAuthJwtLogin]
    A configuration block, described below, that attempts to authenticate using JWT authentication. The JWT can be provided as a command line variable or it will be pulled out of an environment variable named AKEYLESSAUTHJWT.
    uid_logins Sequence[GetAuthUidLogin]
    A configuration block, described below, that attempts to authenticate using Universal Identity authentication.
    apiKeyLogins List<Property Map>
    A configuration block, described below, that attempts to authenticate using API-Key.
    awsIamLogins List<Property Map>
    A configuration block, described below, that attempts to authenticate using AWS-IAM authentication credentials.
    azureAdLogins List<Property Map>
    A configuration block, described below, that attempts to authenticate using Azure Active Directory authentication.
    certLogins List<Property Map>
    A configuration block, described below, that attempts to authenticate using Certificate authentication. The Certificate and the Private key can be provided as a command line variable or it will be pulled out of an environment variable named AKEYLESSAUTHCERT and AKEYLESSAUTHKEY.
    emailLogins List<Property Map>
    A configuration block, described below, that attempts to authenticate using email and password.
    gcpLogins List<Property Map>
    A configuration block, described below, that attempts to authenticate using GCP-IAM authentication credentials.
    id String
    The ID of this resource.
    jwtLogins List<Property Map>
    A configuration block, described below, that attempts to authenticate using JWT authentication. The JWT can be provided as a command line variable or it will be pulled out of an environment variable named AKEYLESSAUTHJWT.
    uidLogins List<Property Map>
    A configuration block, described below, that attempts to authenticate using Universal Identity authentication.

    getAuth Result

    The following output properties are available:

    Id string
    The ID of this resource.
    Token string
    The token
    ApiKeyLogins List<GetAuthApiKeyLogin>
    A configuration block, described below, that attempts to authenticate using API-Key.
    AwsIamLogins List<GetAuthAwsIamLogin>
    A configuration block, described below, that attempts to authenticate using AWS-IAM authentication credentials.
    AzureAdLogins List<GetAuthAzureAdLogin>
    A configuration block, described below, that attempts to authenticate using Azure Active Directory authentication.
    CertLogins List<GetAuthCertLogin>
    A configuration block, described below, that attempts to authenticate using Certificate authentication. The Certificate and the Private key can be provided as a command line variable or it will be pulled out of an environment variable named AKEYLESSAUTHCERT and AKEYLESSAUTHKEY.
    EmailLogins List<GetAuthEmailLogin>
    A configuration block, described below, that attempts to authenticate using email and password.
    GcpLogins List<GetAuthGcpLogin>
    A configuration block, described below, that attempts to authenticate using GCP-IAM authentication credentials.
    JwtLogins List<GetAuthJwtLogin>
    A configuration block, described below, that attempts to authenticate using JWT authentication. The JWT can be provided as a command line variable or it will be pulled out of an environment variable named AKEYLESSAUTHJWT.
    UidLogins List<GetAuthUidLogin>
    A configuration block, described below, that attempts to authenticate using Universal Identity authentication.
    Id string
    The ID of this resource.
    Token string
    The token
    ApiKeyLogins []GetAuthApiKeyLogin
    A configuration block, described below, that attempts to authenticate using API-Key.
    AwsIamLogins []GetAuthAwsIamLogin
    A configuration block, described below, that attempts to authenticate using AWS-IAM authentication credentials.
    AzureAdLogins []GetAuthAzureAdLogin
    A configuration block, described below, that attempts to authenticate using Azure Active Directory authentication.
    CertLogins []GetAuthCertLogin
    A configuration block, described below, that attempts to authenticate using Certificate authentication. The Certificate and the Private key can be provided as a command line variable or it will be pulled out of an environment variable named AKEYLESSAUTHCERT and AKEYLESSAUTHKEY.
    EmailLogins []GetAuthEmailLogin
    A configuration block, described below, that attempts to authenticate using email and password.
    GcpLogins []GetAuthGcpLogin
    A configuration block, described below, that attempts to authenticate using GCP-IAM authentication credentials.
    JwtLogins []GetAuthJwtLogin
    A configuration block, described below, that attempts to authenticate using JWT authentication. The JWT can be provided as a command line variable or it will be pulled out of an environment variable named AKEYLESSAUTHJWT.
    UidLogins []GetAuthUidLogin
    A configuration block, described below, that attempts to authenticate using Universal Identity authentication.
    id String
    The ID of this resource.
    token String
    The token
    apiKeyLogins List<GetAuthApiKeyLogin>
    A configuration block, described below, that attempts to authenticate using API-Key.
    awsIamLogins List<GetAuthAwsIamLogin>
    A configuration block, described below, that attempts to authenticate using AWS-IAM authentication credentials.
    azureAdLogins List<GetAuthAzureAdLogin>
    A configuration block, described below, that attempts to authenticate using Azure Active Directory authentication.
    certLogins List<GetAuthCertLogin>
    A configuration block, described below, that attempts to authenticate using Certificate authentication. The Certificate and the Private key can be provided as a command line variable or it will be pulled out of an environment variable named AKEYLESSAUTHCERT and AKEYLESSAUTHKEY.
    emailLogins List<GetAuthEmailLogin>
    A configuration block, described below, that attempts to authenticate using email and password.
    gcpLogins List<GetAuthGcpLogin>
    A configuration block, described below, that attempts to authenticate using GCP-IAM authentication credentials.
    jwtLogins List<GetAuthJwtLogin>
    A configuration block, described below, that attempts to authenticate using JWT authentication. The JWT can be provided as a command line variable or it will be pulled out of an environment variable named AKEYLESSAUTHJWT.
    uidLogins List<GetAuthUidLogin>
    A configuration block, described below, that attempts to authenticate using Universal Identity authentication.
    id string
    The ID of this resource.
    token string
    The token
    apiKeyLogins GetAuthApiKeyLogin[]
    A configuration block, described below, that attempts to authenticate using API-Key.
    awsIamLogins GetAuthAwsIamLogin[]
    A configuration block, described below, that attempts to authenticate using AWS-IAM authentication credentials.
    azureAdLogins GetAuthAzureAdLogin[]
    A configuration block, described below, that attempts to authenticate using Azure Active Directory authentication.
    certLogins GetAuthCertLogin[]
    A configuration block, described below, that attempts to authenticate using Certificate authentication. The Certificate and the Private key can be provided as a command line variable or it will be pulled out of an environment variable named AKEYLESSAUTHCERT and AKEYLESSAUTHKEY.
    emailLogins GetAuthEmailLogin[]
    A configuration block, described below, that attempts to authenticate using email and password.
    gcpLogins GetAuthGcpLogin[]
    A configuration block, described below, that attempts to authenticate using GCP-IAM authentication credentials.
    jwtLogins GetAuthJwtLogin[]
    A configuration block, described below, that attempts to authenticate using JWT authentication. The JWT can be provided as a command line variable or it will be pulled out of an environment variable named AKEYLESSAUTHJWT.
    uidLogins GetAuthUidLogin[]
    A configuration block, described below, that attempts to authenticate using Universal Identity authentication.
    id str
    The ID of this resource.
    token str
    The token
    api_key_logins Sequence[GetAuthApiKeyLogin]
    A configuration block, described below, that attempts to authenticate using API-Key.
    aws_iam_logins Sequence[GetAuthAwsIamLogin]
    A configuration block, described below, that attempts to authenticate using AWS-IAM authentication credentials.
    azure_ad_logins Sequence[GetAuthAzureAdLogin]
    A configuration block, described below, that attempts to authenticate using Azure Active Directory authentication.
    cert_logins Sequence[GetAuthCertLogin]
    A configuration block, described below, that attempts to authenticate using Certificate authentication. The Certificate and the Private key can be provided as a command line variable or it will be pulled out of an environment variable named AKEYLESSAUTHCERT and AKEYLESSAUTHKEY.
    email_logins Sequence[GetAuthEmailLogin]
    A configuration block, described below, that attempts to authenticate using email and password.
    gcp_logins Sequence[GetAuthGcpLogin]
    A configuration block, described below, that attempts to authenticate using GCP-IAM authentication credentials.
    jwt_logins Sequence[GetAuthJwtLogin]
    A configuration block, described below, that attempts to authenticate using JWT authentication. The JWT can be provided as a command line variable or it will be pulled out of an environment variable named AKEYLESSAUTHJWT.
    uid_logins Sequence[GetAuthUidLogin]
    A configuration block, described below, that attempts to authenticate using Universal Identity authentication.
    id String
    The ID of this resource.
    token String
    The token
    apiKeyLogins List<Property Map>
    A configuration block, described below, that attempts to authenticate using API-Key.
    awsIamLogins List<Property Map>
    A configuration block, described below, that attempts to authenticate using AWS-IAM authentication credentials.
    azureAdLogins List<Property Map>
    A configuration block, described below, that attempts to authenticate using Azure Active Directory authentication.
    certLogins List<Property Map>
    A configuration block, described below, that attempts to authenticate using Certificate authentication. The Certificate and the Private key can be provided as a command line variable or it will be pulled out of an environment variable named AKEYLESSAUTHCERT and AKEYLESSAUTHKEY.
    emailLogins List<Property Map>
    A configuration block, described below, that attempts to authenticate using email and password.
    gcpLogins List<Property Map>
    A configuration block, described below, that attempts to authenticate using GCP-IAM authentication credentials.
    jwtLogins List<Property Map>
    A configuration block, described below, that attempts to authenticate using JWT authentication. The JWT can be provided as a command line variable or it will be pulled out of an environment variable named AKEYLESSAUTHJWT.
    uidLogins List<Property Map>
    A configuration block, described below, that attempts to authenticate using Universal Identity authentication.

    Supporting Types

    GetAuthApiKeyLogin

    AccessId string
    AccessKey string
    AccessId string
    AccessKey string
    accessId String
    accessKey String
    accessId string
    accessKey string
    accessId String
    accessKey String

    GetAuthAwsIamLogin

    AccessId string
    AccessId string
    accessId String
    accessId string
    accessId String

    GetAuthAzureAdLogin

    AccessId string
    AccessId string
    accessId String
    accessId string
    accessId String

    GetAuthCertLogin

    AccessId string
    CertData string
    CertFileName string
    KeyData string
    KeyFileName string
    AccessId string
    CertData string
    CertFileName string
    KeyData string
    KeyFileName string
    accessId String
    certData String
    certFileName String
    keyData String
    keyFileName String
    accessId string
    certData string
    certFileName string
    keyData string
    keyFileName string
    accessId String
    certData String
    certFileName String
    keyData String
    keyFileName String

    GetAuthEmailLogin

    GetAuthGcpLogin

    AccessId string
    Audience string
    AccessId string
    Audience string
    accessId String
    audience String
    accessId string
    audience string
    accessId String
    audience String

    GetAuthJwtLogin

    AccessId string
    Jwt string
    AccessId string
    Jwt string
    accessId String
    jwt String
    accessId string
    jwt string
    access_id str
    jwt str
    accessId String
    jwt String

    GetAuthUidLogin

    UidToken string
    AccessId string
    UidToken string
    AccessId string
    uidToken String
    accessId String
    uidToken string
    accessId string
    uidToken String
    accessId String

    Package Details

    Repository
    akeyless akeyless-community/terraform-provider-akeyless
    License
    Notes
    This Pulumi package is based on the akeyless Terraform Provider.
    akeyless logo
    akeyless 1.9.0 published on Monday, Apr 14, 2025 by akeyless-community
    akeyless-community/terraform-provider-akeyless