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

akeyless.AuthMethod

Explore with Pulumi AI

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

    Authentication Methods represent machine identities or human identities

    Create AuthMethod Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new AuthMethod(name: string, args: AuthMethodArgs, opts?: CustomResourceOptions);
    @overload
def AuthMethod(resource_name: str,
               args: AuthMethodArgs,
               opts: Optional[ResourceOptions] = None)

@overload
def AuthMethod(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               path: Optional[str] = None,
               access_expires: Optional[float] = None,
               api_keys: Optional[Sequence[AuthMethodApiKeyArgs]] = None,
               auth_method_id: Optional[str] = None,
               aws_iams: Optional[Sequence[AuthMethodAwsIamArgs]] = None,
               azure_ads: Optional[Sequence[AuthMethodAzureAdArgs]] = None,
               bound_ips: Optional[str] = None,
               gcps: Optional[Sequence[AuthMethodGcpArgs]] = None,
               samls: Optional[Sequence[AuthMethodSamlArgs]] = None)
    func NewAuthMethod(ctx *Context, name string, args AuthMethodArgs, opts ...ResourceOption) (*AuthMethod, error)
    public AuthMethod(string name, AuthMethodArgs args, CustomResourceOptions? opts = null)
    public AuthMethod(String name, AuthMethodArgs args)
public AuthMethod(String name, AuthMethodArgs args, CustomResourceOptions options)

    type: akeyless:AuthMethod
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args AuthMethodArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args AuthMethodArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args AuthMethodArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args AuthMethodArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args AuthMethodArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var authMethodResource = new Akeyless.AuthMethod("authMethodResource", new()
{
    Path = "string",
    AccessExpires = 0,
    ApiKeys = new[]
    {
        null,
    },
    AuthMethodId = "string",
    AwsIams = new[]
    {
        new Akeyless.Inputs.AuthMethodAwsIamArgs
        {
            BoundAwsAccountIds = new[]
            {
                "string",
            },
            BoundArns = new[]
            {
                "string",
            },
            BoundResourceIds = new[]
            {
                "string",
            },
            BoundRoleIds = new[]
            {
                "string",
            },
            BoundRoleNames = new[]
            {
                "string",
            },
            BoundUserIds = new[]
            {
                "string",
            },
            BoundUserNames = new[]
            {
                "string",
            },
            StsUrl = "string",
        },
    },
    AzureAds = new[]
    {
        new Akeyless.Inputs.AuthMethodAzureAdArgs
        {
            BoundTenantId = "string",
            BoundGroupIds = new[]
            {
                "string",
            },
            BoundProviders = new[]
            {
                "string",
            },
            BoundResourceIds = new[]
            {
                "string",
            },
            BoundResourceNames = new[]
            {
                "string",
            },
            BoundResourceTypes = new[]
            {
                "string",
            },
            BoundRgIds = new[]
            {
                "string",
            },
            BoundSpids = new[]
            {
                "string",
            },
            BoundSubIds = new[]
            {
                "string",
            },
            CustomAudience = "string",
            CustomIssuer = "string",
            JwksUri = "string",
        },
    },
    BoundIps = "string",
    Gcps = new[]
    {
        new Akeyless.Inputs.AuthMethodGcpArgs
        {
            ServiceAccountCredsData = "string",
            Audience = "string",
            Gces = new[]
            {
                new Akeyless.Inputs.AuthMethodGcpGceArgs
                {
                    BoundLabels = new[]
                    {
                        "string",
                    },
                    BoundRegions = new[]
                    {
                        "string",
                    },
                    BoundZones = new[]
                    {
                        "string",
                    },
                },
            },
            Iams = new[]
            {
                new Akeyless.Inputs.AuthMethodGcpIamArgs
                {
                    BoundServiceAccounts = new[]
                    {
                        "string",
                    },
                },
            },
        },
    },
    Samls = new[]
    {
        new Akeyless.Inputs.AuthMethodSamlArgs
        {
            UniqueIdentifier = "string",
            IdpMetadataUrl = "string",
            IdpMetadataXmlData = "string",
        },
    },
});

    example, err := akeyless.NewAuthMethod(ctx, "authMethodResource", &akeyless.AuthMethodArgs{
	Path:          pulumi.String("string"),
	AccessExpires: pulumi.Float64(0),
	ApiKeys: akeyless.AuthMethodApiKeyTypeArray{
		&akeyless.AuthMethodApiKeyTypeArgs{},
	},
	AuthMethodId: pulumi.String("string"),
	AwsIams: akeyless.AuthMethodAwsIamTypeArray{
		&akeyless.AuthMethodAwsIamTypeArgs{
			BoundAwsAccountIds: pulumi.StringArray{
				pulumi.String("string"),
			},
			BoundArns: pulumi.StringArray{
				pulumi.String("string"),
			},
			BoundResourceIds: pulumi.StringArray{
				pulumi.String("string"),
			},
			BoundRoleIds: pulumi.StringArray{
				pulumi.String("string"),
			},
			BoundRoleNames: pulumi.StringArray{
				pulumi.String("string"),
			},
			BoundUserIds: pulumi.StringArray{
				pulumi.String("string"),
			},
			BoundUserNames: pulumi.StringArray{
				pulumi.String("string"),
			},
			StsUrl: pulumi.String("string"),
		},
	},
	AzureAds: akeyless.AuthMethodAzureAdTypeArray{
		&akeyless.AuthMethodAzureAdTypeArgs{
			BoundTenantId: pulumi.String("string"),
			BoundGroupIds: pulumi.StringArray{
				pulumi.String("string"),
			},
			BoundProviders: pulumi.StringArray{
				pulumi.String("string"),
			},
			BoundResourceIds: pulumi.StringArray{
				pulumi.String("string"),
			},
			BoundResourceNames: pulumi.StringArray{
				pulumi.String("string"),
			},
			BoundResourceTypes: pulumi.StringArray{
				pulumi.String("string"),
			},
			BoundRgIds: pulumi.StringArray{
				pulumi.String("string"),
			},
			BoundSpids: pulumi.StringArray{
				pulumi.String("string"),
			},
			BoundSubIds: pulumi.StringArray{
				pulumi.String("string"),
			},
			CustomAudience: pulumi.String("string"),
			CustomIssuer:   pulumi.String("string"),
			JwksUri:        pulumi.String("string"),
		},
	},
	BoundIps: pulumi.String("string"),
	Gcps: akeyless.AuthMethodGcpTypeArray{
		&akeyless.AuthMethodGcpTypeArgs{
			ServiceAccountCredsData: pulumi.String("string"),
			Audience:                pulumi.String("string"),
			Gces: akeyless.AuthMethodGcpGceArray{
				&akeyless.AuthMethodGcpGceArgs{
					BoundLabels: pulumi.StringArray{
						pulumi.String("string"),
					},
					BoundRegions: pulumi.StringArray{
						pulumi.String("string"),
					},
					BoundZones: pulumi.StringArray{
						pulumi.String("string"),
					},
				},
			},
			Iams: akeyless.AuthMethodGcpIamArray{
				&akeyless.AuthMethodGcpIamArgs{
					BoundServiceAccounts: pulumi.StringArray{
						pulumi.String("string"),
					},
				},
			},
		},
	},
	Samls: akeyless.AuthMethodSamlTypeArray{
		&akeyless.AuthMethodSamlTypeArgs{
			UniqueIdentifier:   pulumi.String("string"),
			IdpMetadataUrl:     pulumi.String("string"),
			IdpMetadataXmlData: pulumi.String("string"),
		},
	},
})

    var authMethodResource = new AuthMethod("authMethodResource", AuthMethodArgs.builder()
    .path("string")
    .accessExpires(0)
    .apiKeys()
    .authMethodId("string")
    .awsIams(AuthMethodAwsIamArgs.builder()
        .boundAwsAccountIds("string")
        .boundArns("string")
        .boundResourceIds("string")
        .boundRoleIds("string")
        .boundRoleNames("string")
        .boundUserIds("string")
        .boundUserNames("string")
        .stsUrl("string")
        .build())
    .azureAds(AuthMethodAzureAdArgs.builder()
        .boundTenantId("string")
        .boundGroupIds("string")
        .boundProviders("string")
        .boundResourceIds("string")
        .boundResourceNames("string")
        .boundResourceTypes("string")
        .boundRgIds("string")
        .boundSpids("string")
        .boundSubIds("string")
        .customAudience("string")
        .customIssuer("string")
        .jwksUri("string")
        .build())
    .boundIps("string")
    .gcps(AuthMethodGcpArgs.builder()
        .serviceAccountCredsData("string")
        .audience("string")
        .gces(AuthMethodGcpGceArgs.builder()
            .boundLabels("string")
            .boundRegions("string")
            .boundZones("string")
            .build())
        .iams(AuthMethodGcpIamArgs.builder()
            .boundServiceAccounts("string")
            .build())
        .build())
    .samls(AuthMethodSamlArgs.builder()
        .uniqueIdentifier("string")
        .idpMetadataUrl("string")
        .idpMetadataXmlData("string")
        .build())
    .build());

    auth_method_resource = akeyless.AuthMethod("authMethodResource",
    path="string",
    access_expires=0,
    api_keys=[{}],
    auth_method_id="string",
    aws_iams=[{
        "bound_aws_account_ids": ["string"],
        "bound_arns": ["string"],
        "bound_resource_ids": ["string"],
        "bound_role_ids": ["string"],
        "bound_role_names": ["string"],
        "bound_user_ids": ["string"],
        "bound_user_names": ["string"],
        "sts_url": "string",
    }],
    azure_ads=[{
        "bound_tenant_id": "string",
        "bound_group_ids": ["string"],
        "bound_providers": ["string"],
        "bound_resource_ids": ["string"],
        "bound_resource_names": ["string"],
        "bound_resource_types": ["string"],
        "bound_rg_ids": ["string"],
        "bound_spids": ["string"],
        "bound_sub_ids": ["string"],
        "custom_audience": "string",
        "custom_issuer": "string",
        "jwks_uri": "string",
    }],
    bound_ips="string",
    gcps=[{
        "service_account_creds_data": "string",
        "audience": "string",
        "gces": [{
            "bound_labels": ["string"],
            "bound_regions": ["string"],
            "bound_zones": ["string"],
        }],
        "iams": [{
            "bound_service_accounts": ["string"],
        }],
    }],
    samls=[{
        "unique_identifier": "string",
        "idp_metadata_url": "string",
        "idp_metadata_xml_data": "string",
    }])

    const authMethodResource = new akeyless.AuthMethod("authMethodResource", {
    path: "string",
    accessExpires: 0,
    apiKeys: [{}],
    authMethodId: "string",
    awsIams: [{
        boundAwsAccountIds: ["string"],
        boundArns: ["string"],
        boundResourceIds: ["string"],
        boundRoleIds: ["string"],
        boundRoleNames: ["string"],
        boundUserIds: ["string"],
        boundUserNames: ["string"],
        stsUrl: "string",
    }],
    azureAds: [{
        boundTenantId: "string",
        boundGroupIds: ["string"],
        boundProviders: ["string"],
        boundResourceIds: ["string"],
        boundResourceNames: ["string"],
        boundResourceTypes: ["string"],
        boundRgIds: ["string"],
        boundSpids: ["string"],
        boundSubIds: ["string"],
        customAudience: "string",
        customIssuer: "string",
        jwksUri: "string",
    }],
    boundIps: "string",
    gcps: [{
        serviceAccountCredsData: "string",
        audience: "string",
        gces: [{
            boundLabels: ["string"],
            boundRegions: ["string"],
            boundZones: ["string"],
        }],
        iams: [{
            boundServiceAccounts: ["string"],
        }],
    }],
    samls: [{
        uniqueIdentifier: "string",
        idpMetadataUrl: "string",
        idpMetadataXmlData: "string",
    }],
});

    type: akeyless:AuthMethod
properties:
    accessExpires: 0
    apiKeys:
        - {}
    authMethodId: string
    awsIams:
        - boundArns:
            - string
          boundAwsAccountIds:
            - string
          boundResourceIds:
            - string
          boundRoleIds:
            - string
          boundRoleNames:
            - string
          boundUserIds:
            - string
          boundUserNames:
            - string
          stsUrl: string
    azureAds:
        - boundGroupIds:
            - string
          boundProviders:
            - string
          boundResourceIds:
            - string
          boundResourceNames:
            - string
          boundResourceTypes:
            - string
          boundRgIds:
            - string
          boundSpids:
            - string
          boundSubIds:
            - string
          boundTenantId: string
          customAudience: string
          customIssuer: string
          jwksUri: string
    boundIps: string
    gcps:
        - audience: string
          gces:
            - boundLabels:
                - string
              boundRegions:
                - string
              boundZones:
                - string
          iams:
            - boundServiceAccounts:
                - string
          serviceAccountCredsData: string
    path: string
    samls:
        - idpMetadataUrl: string
          idpMetadataXmlData: string
          uniqueIdentifier: string

    AuthMethod Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The AuthMethod resource accepts the following input properties:

    Path string
    The path where the Auth Method will be stored
    AccessExpires double
    Access expiration date in Unix timestamp (select 0 for access without expiry date)
    ApiKeys List<AuthMethodApiKey>
    A configuration block, described below, using API-Key Auth Method
    AuthMethodId string
    The ID of this resource.
    AwsIams List<AuthMethodAwsIam>
    A configuration block, described below, using AWS-IAM Auth Method
    AzureAds List<AuthMethodAzureAd>
    A configuration block, described below, using Azure AD Auth Method
    BoundIps string
    A CIDR whitelist with the IPs that the access is restricted to
    Gcps List<AuthMethodGcp>
    A configuration block, described below, using Auth Method API-Key
    Samls List<AuthMethodSaml>
    A configuration block, described below, using SAML Auth Method
    Path string
    The path where the Auth Method will be stored
    AccessExpires float64
    Access expiration date in Unix timestamp (select 0 for access without expiry date)
    ApiKeys []AuthMethodApiKeyTypeArgs
    A configuration block, described below, using API-Key Auth Method
    AuthMethodId string
    The ID of this resource.
    AwsIams []AuthMethodAwsIamTypeArgs
    A configuration block, described below, using AWS-IAM Auth Method
    AzureAds []AuthMethodAzureAdTypeArgs
    A configuration block, described below, using Azure AD Auth Method
    BoundIps string
    A CIDR whitelist with the IPs that the access is restricted to
    Gcps []AuthMethodGcpTypeArgs
    A configuration block, described below, using Auth Method API-Key
    Samls []AuthMethodSamlTypeArgs
    A configuration block, described below, using SAML Auth Method
    path String
    The path where the Auth Method will be stored
    accessExpires Double
    Access expiration date in Unix timestamp (select 0 for access without expiry date)
    apiKeys List<AuthMethodApiKey>
    A configuration block, described below, using API-Key Auth Method
    authMethodId String
    The ID of this resource.
    awsIams List<AuthMethodAwsIam>
    A configuration block, described below, using AWS-IAM Auth Method
    azureAds List<AuthMethodAzureAd>
    A configuration block, described below, using Azure AD Auth Method
    boundIps String
    A CIDR whitelist with the IPs that the access is restricted to
    gcps List<AuthMethodGcp>
    A configuration block, described below, using Auth Method API-Key
    samls List<AuthMethodSaml>
    A configuration block, described below, using SAML Auth Method
    path string
    The path where the Auth Method will be stored
    accessExpires number
    Access expiration date in Unix timestamp (select 0 for access without expiry date)
    apiKeys AuthMethodApiKey[]
    A configuration block, described below, using API-Key Auth Method
    authMethodId string
    The ID of this resource.
    awsIams AuthMethodAwsIam[]
    A configuration block, described below, using AWS-IAM Auth Method
    azureAds AuthMethodAzureAd[]
    A configuration block, described below, using Azure AD Auth Method
    boundIps string
    A CIDR whitelist with the IPs that the access is restricted to
    gcps AuthMethodGcp[]
    A configuration block, described below, using Auth Method API-Key
    samls AuthMethodSaml[]
    A configuration block, described below, using SAML Auth Method
    path str
    The path where the Auth Method will be stored
    access_expires float
    Access expiration date in Unix timestamp (select 0 for access without expiry date)
    api_keys Sequence[AuthMethodApiKeyArgs]
    A configuration block, described below, using API-Key Auth Method
    auth_method_id str
    The ID of this resource.
    aws_iams Sequence[AuthMethodAwsIamArgs]
    A configuration block, described below, using AWS-IAM Auth Method
    azure_ads Sequence[AuthMethodAzureAdArgs]
    A configuration block, described below, using Azure AD Auth Method
    bound_ips str
    A CIDR whitelist with the IPs that the access is restricted to
    gcps Sequence[AuthMethodGcpArgs]
    A configuration block, described below, using Auth Method API-Key
    samls Sequence[AuthMethodSamlArgs]
    A configuration block, described below, using SAML Auth Method
    path String
    The path where the Auth Method will be stored
    accessExpires Number
    Access expiration date in Unix timestamp (select 0 for access without expiry date)
    apiKeys List<Property Map>
    A configuration block, described below, using API-Key Auth Method
    authMethodId String
    The ID of this resource.
    awsIams List<Property Map>
    A configuration block, described below, using AWS-IAM Auth Method
    azureAds List<Property Map>
    A configuration block, described below, using Azure AD Auth Method
    boundIps String
    A CIDR whitelist with the IPs that the access is restricted to
    gcps List<Property Map>
    A configuration block, described below, using Auth Method API-Key
    samls List<Property Map>
    A configuration block, described below, using SAML Auth Method

    Outputs

    All input properties are implicitly available as output properties. Additionally, the AuthMethod resource produces the following output properties:

    AccessId string
    Auth Method access ID
    AccessKey string
    Auth Method access key
    Id string
    The provider-assigned unique ID for this managed resource.
    AccessId string
    Auth Method access ID
    AccessKey string
    Auth Method access key
    Id string
    The provider-assigned unique ID for this managed resource.
    accessId String
    Auth Method access ID
    accessKey String
    Auth Method access key
    id String
    The provider-assigned unique ID for this managed resource.
    accessId string
    Auth Method access ID
    accessKey string
    Auth Method access key
    id string
    The provider-assigned unique ID for this managed resource.
    access_id str
    Auth Method access ID
    access_key str
    Auth Method access key
    id str
    The provider-assigned unique ID for this managed resource.
    accessId String
    Auth Method access ID
    accessKey String
    Auth Method access key
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing AuthMethod Resource

    Get an existing AuthMethod resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: AuthMethodState, opts?: CustomResourceOptions): AuthMethod
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        access_expires: Optional[float] = None,
        access_id: Optional[str] = None,
        access_key: Optional[str] = None,
        api_keys: Optional[Sequence[AuthMethodApiKeyArgs]] = None,
        auth_method_id: Optional[str] = None,
        aws_iams: Optional[Sequence[AuthMethodAwsIamArgs]] = None,
        azure_ads: Optional[Sequence[AuthMethodAzureAdArgs]] = None,
        bound_ips: Optional[str] = None,
        gcps: Optional[Sequence[AuthMethodGcpArgs]] = None,
        path: Optional[str] = None,
        samls: Optional[Sequence[AuthMethodSamlArgs]] = None) -> AuthMethod
    func GetAuthMethod(ctx *Context, name string, id IDInput, state *AuthMethodState, opts ...ResourceOption) (*AuthMethod, error)
    public static AuthMethod Get(string name, Input<string> id, AuthMethodState? state, CustomResourceOptions? opts = null)
    public static AuthMethod get(String name, Output<String> id, AuthMethodState state, CustomResourceOptions options)
    resources:  _:    type: akeyless:AuthMethod    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    AccessExpires double
    Access expiration date in Unix timestamp (select 0 for access without expiry date)
    AccessId string
    Auth Method access ID
    AccessKey string
    Auth Method access key
    ApiKeys List<AuthMethodApiKey>
    A configuration block, described below, using API-Key Auth Method
    AuthMethodId string
    The ID of this resource.
    AwsIams List<AuthMethodAwsIam>
    A configuration block, described below, using AWS-IAM Auth Method
    AzureAds List<AuthMethodAzureAd>
    A configuration block, described below, using Azure AD Auth Method
    BoundIps string
    A CIDR whitelist with the IPs that the access is restricted to
    Gcps List<AuthMethodGcp>
    A configuration block, described below, using Auth Method API-Key
    Path string
    The path where the Auth Method will be stored
    Samls List<AuthMethodSaml>
    A configuration block, described below, using SAML Auth Method
    AccessExpires float64
    Access expiration date in Unix timestamp (select 0 for access without expiry date)
    AccessId string
    Auth Method access ID
    AccessKey string
    Auth Method access key
    ApiKeys []AuthMethodApiKeyTypeArgs
    A configuration block, described below, using API-Key Auth Method
    AuthMethodId string
    The ID of this resource.
    AwsIams []AuthMethodAwsIamTypeArgs
    A configuration block, described below, using AWS-IAM Auth Method
    AzureAds []AuthMethodAzureAdTypeArgs
    A configuration block, described below, using Azure AD Auth Method
    BoundIps string
    A CIDR whitelist with the IPs that the access is restricted to
    Gcps []AuthMethodGcpTypeArgs
    A configuration block, described below, using Auth Method API-Key
    Path string
    The path where the Auth Method will be stored
    Samls []AuthMethodSamlTypeArgs
    A configuration block, described below, using SAML Auth Method
    accessExpires Double
    Access expiration date in Unix timestamp (select 0 for access without expiry date)
    accessId String
    Auth Method access ID
    accessKey String
    Auth Method access key
    apiKeys List<AuthMethodApiKey>
    A configuration block, described below, using API-Key Auth Method
    authMethodId String
    The ID of this resource.
    awsIams List<AuthMethodAwsIam>
    A configuration block, described below, using AWS-IAM Auth Method
    azureAds List<AuthMethodAzureAd>
    A configuration block, described below, using Azure AD Auth Method
    boundIps String
    A CIDR whitelist with the IPs that the access is restricted to
    gcps List<AuthMethodGcp>
    A configuration block, described below, using Auth Method API-Key
    path String
    The path where the Auth Method will be stored
    samls List<AuthMethodSaml>
    A configuration block, described below, using SAML Auth Method
    accessExpires number
    Access expiration date in Unix timestamp (select 0 for access without expiry date)
    accessId string
    Auth Method access ID
    accessKey string
    Auth Method access key
    apiKeys AuthMethodApiKey[]
    A configuration block, described below, using API-Key Auth Method
    authMethodId string
    The ID of this resource.
    awsIams AuthMethodAwsIam[]
    A configuration block, described below, using AWS-IAM Auth Method
    azureAds AuthMethodAzureAd[]
    A configuration block, described below, using Azure AD Auth Method
    boundIps string
    A CIDR whitelist with the IPs that the access is restricted to
    gcps AuthMethodGcp[]
    A configuration block, described below, using Auth Method API-Key
    path string
    The path where the Auth Method will be stored
    samls AuthMethodSaml[]
    A configuration block, described below, using SAML Auth Method
    access_expires float
    Access expiration date in Unix timestamp (select 0 for access without expiry date)
    access_id str
    Auth Method access ID
    access_key str
    Auth Method access key
    api_keys Sequence[AuthMethodApiKeyArgs]
    A configuration block, described below, using API-Key Auth Method
    auth_method_id str
    The ID of this resource.
    aws_iams Sequence[AuthMethodAwsIamArgs]
    A configuration block, described below, using AWS-IAM Auth Method
    azure_ads Sequence[AuthMethodAzureAdArgs]
    A configuration block, described below, using Azure AD Auth Method
    bound_ips str
    A CIDR whitelist with the IPs that the access is restricted to
    gcps Sequence[AuthMethodGcpArgs]
    A configuration block, described below, using Auth Method API-Key
    path str
    The path where the Auth Method will be stored
    samls Sequence[AuthMethodSamlArgs]
    A configuration block, described below, using SAML Auth Method
    accessExpires Number
    Access expiration date in Unix timestamp (select 0 for access without expiry date)
    accessId String
    Auth Method access ID
    accessKey String
    Auth Method access key
    apiKeys List<Property Map>
    A configuration block, described below, using API-Key Auth Method
    authMethodId String
    The ID of this resource.
    awsIams List<Property Map>
    A configuration block, described below, using AWS-IAM Auth Method
    azureAds List<Property Map>
    A configuration block, described below, using Azure AD Auth Method
    boundIps String
    A CIDR whitelist with the IPs that the access is restricted to
    gcps List<Property Map>
    A configuration block, described below, using Auth Method API-Key
    path String
    The path where the Auth Method will be stored
    samls List<Property Map>
    A configuration block, described below, using SAML Auth Method

    Supporting Types

    AuthMethodAwsIam, AuthMethodAwsIamArgs

    BoundAwsAccountIds List<string>
    A list of AWS account-IDs that the access is restricted to
    BoundArns List<string>
    A list of full arns that the access is restricted to
    BoundResourceIds List<string>
    A list of full resource ids that the access is restricted to
    BoundRoleIds List<string>
    A list of full role ids that the access is restricted to
    BoundRoleNames List<string>
    A list of full role-name that the access is restricted to
    BoundUserIds List<string>
    A list of full user ids that the access is restricted to
    BoundUserNames List<string>
    A list of full user-name that the access is restricted to
    StsUrl string
    STS URL (default: https://sts.amazonaws.com)
    BoundAwsAccountIds []string
    A list of AWS account-IDs that the access is restricted to
    BoundArns []string
    A list of full arns that the access is restricted to
    BoundResourceIds []string
    A list of full resource ids that the access is restricted to
    BoundRoleIds []string
    A list of full role ids that the access is restricted to
    BoundRoleNames []string
    A list of full role-name that the access is restricted to
    BoundUserIds []string
    A list of full user ids that the access is restricted to
    BoundUserNames []string
    A list of full user-name that the access is restricted to
    StsUrl string
    STS URL (default: https://sts.amazonaws.com)
    boundAwsAccountIds List<String>
    A list of AWS account-IDs that the access is restricted to
    boundArns List<String>
    A list of full arns that the access is restricted to
    boundResourceIds List<String>
    A list of full resource ids that the access is restricted to
    boundRoleIds List<String>
    A list of full role ids that the access is restricted to
    boundRoleNames List<String>
    A list of full role-name that the access is restricted to
    boundUserIds List<String>
    A list of full user ids that the access is restricted to
    boundUserNames List<String>
    A list of full user-name that the access is restricted to
    stsUrl String
    STS URL (default: https://sts.amazonaws.com)
    boundAwsAccountIds string[]
    A list of AWS account-IDs that the access is restricted to
    boundArns string[]
    A list of full arns that the access is restricted to
    boundResourceIds string[]
    A list of full resource ids that the access is restricted to
    boundRoleIds string[]
    A list of full role ids that the access is restricted to
    boundRoleNames string[]
    A list of full role-name that the access is restricted to
    boundUserIds string[]
    A list of full user ids that the access is restricted to
    boundUserNames string[]
    A list of full user-name that the access is restricted to
    stsUrl string
    STS URL (default: https://sts.amazonaws.com)
    bound_aws_account_ids Sequence[str]
    A list of AWS account-IDs that the access is restricted to
    bound_arns Sequence[str]
    A list of full arns that the access is restricted to
    bound_resource_ids Sequence[str]
    A list of full resource ids that the access is restricted to
    bound_role_ids Sequence[str]
    A list of full role ids that the access is restricted to
    bound_role_names Sequence[str]
    A list of full role-name that the access is restricted to
    bound_user_ids Sequence[str]
    A list of full user ids that the access is restricted to
    bound_user_names Sequence[str]
    A list of full user-name that the access is restricted to
    sts_url str
    STS URL (default: https://sts.amazonaws.com)
    boundAwsAccountIds List<String>
    A list of AWS account-IDs that the access is restricted to
    boundArns List<String>
    A list of full arns that the access is restricted to
    boundResourceIds List<String>
    A list of full resource ids that the access is restricted to
    boundRoleIds List<String>
    A list of full role ids that the access is restricted to
    boundRoleNames List<String>
    A list of full role-name that the access is restricted to
    boundUserIds List<String>
    A list of full user ids that the access is restricted to
    boundUserNames List<String>
    A list of full user-name that the access is restricted to
    stsUrl String
    STS URL (default: https://sts.amazonaws.com)

    AuthMethodAzureAd, AuthMethodAzureAdArgs

    BoundTenantId string
    The Azure tenant id that the access is restricted to
    BoundGroupIds List<string>
    A list of group ids that the access is restricted to
    BoundProviders List<string>
    A list of resource providers that the access is restricted to (e.g, Microsoft.Compute, Microsoft.ManagedIdentity, etc)
    BoundResourceIds List<string>
    A list of full resource ids that the access is restricted to
    BoundResourceNames List<string>
    A list of resource names that the access is restricted to (e.g, a virtual machine name, scale set name, etc)
    BoundResourceTypes List<string>
    A list of resource types that the access is restricted to (e.g, virtualMachines, userAssignedIdentities, etc)
    BoundRgIds List<string>
    A list of resource groups that the access is restricted to
    BoundSpids List<string>
    A list of service principal IDs that the access is restricted to
    BoundSubIds List<string>
    A list of subscription ids that the access is restricted to
    CustomAudience string
    The audience in the JWT
    CustomIssuer string
    Issuer URL
    JwksUri string
    The URL to the JSON Web Key Set (JWKS) that containing the public keys that should be used to verify any JSON Web Token (JWT) issued by the authorization server
    BoundTenantId string
    The Azure tenant id that the access is restricted to
    BoundGroupIds []string
    A list of group ids that the access is restricted to
    BoundProviders []string
    A list of resource providers that the access is restricted to (e.g, Microsoft.Compute, Microsoft.ManagedIdentity, etc)
    BoundResourceIds []string
    A list of full resource ids that the access is restricted to
    BoundResourceNames []string
    A list of resource names that the access is restricted to (e.g, a virtual machine name, scale set name, etc)
    BoundResourceTypes []string
    A list of resource types that the access is restricted to (e.g, virtualMachines, userAssignedIdentities, etc)
    BoundRgIds []string
    A list of resource groups that the access is restricted to
    BoundSpids []string
    A list of service principal IDs that the access is restricted to
    BoundSubIds []string
    A list of subscription ids that the access is restricted to
    CustomAudience string
    The audience in the JWT
    CustomIssuer string
    Issuer URL
    JwksUri string
    The URL to the JSON Web Key Set (JWKS) that containing the public keys that should be used to verify any JSON Web Token (JWT) issued by the authorization server
    boundTenantId String
    The Azure tenant id that the access is restricted to
    boundGroupIds List<String>
    A list of group ids that the access is restricted to
    boundProviders List<String>
    A list of resource providers that the access is restricted to (e.g, Microsoft.Compute, Microsoft.ManagedIdentity, etc)
    boundResourceIds List<String>
    A list of full resource ids that the access is restricted to
    boundResourceNames List<String>
    A list of resource names that the access is restricted to (e.g, a virtual machine name, scale set name, etc)
    boundResourceTypes List<String>
    A list of resource types that the access is restricted to (e.g, virtualMachines, userAssignedIdentities, etc)
    boundRgIds List<String>
    A list of resource groups that the access is restricted to
    boundSpids List<String>
    A list of service principal IDs that the access is restricted to
    boundSubIds List<String>
    A list of subscription ids that the access is restricted to
    customAudience String
    The audience in the JWT
    customIssuer String
    Issuer URL
    jwksUri String
    The URL to the JSON Web Key Set (JWKS) that containing the public keys that should be used to verify any JSON Web Token (JWT) issued by the authorization server
    boundTenantId string
    The Azure tenant id that the access is restricted to
    boundGroupIds string[]
    A list of group ids that the access is restricted to
    boundProviders string[]
    A list of resource providers that the access is restricted to (e.g, Microsoft.Compute, Microsoft.ManagedIdentity, etc)
    boundResourceIds string[]
    A list of full resource ids that the access is restricted to
    boundResourceNames string[]
    A list of resource names that the access is restricted to (e.g, a virtual machine name, scale set name, etc)
    boundResourceTypes string[]
    A list of resource types that the access is restricted to (e.g, virtualMachines, userAssignedIdentities, etc)
    boundRgIds string[]
    A list of resource groups that the access is restricted to
    boundSpids string[]
    A list of service principal IDs that the access is restricted to
    boundSubIds string[]
    A list of subscription ids that the access is restricted to
    customAudience string
    The audience in the JWT
    customIssuer string
    Issuer URL
    jwksUri string
    The URL to the JSON Web Key Set (JWKS) that containing the public keys that should be used to verify any JSON Web Token (JWT) issued by the authorization server
    bound_tenant_id str
    The Azure tenant id that the access is restricted to
    bound_group_ids Sequence[str]
    A list of group ids that the access is restricted to
    bound_providers Sequence[str]
    A list of resource providers that the access is restricted to (e.g, Microsoft.Compute, Microsoft.ManagedIdentity, etc)
    bound_resource_ids Sequence[str]
    A list of full resource ids that the access is restricted to
    bound_resource_names Sequence[str]
    A list of resource names that the access is restricted to (e.g, a virtual machine name, scale set name, etc)
    bound_resource_types Sequence[str]
    A list of resource types that the access is restricted to (e.g, virtualMachines, userAssignedIdentities, etc)
    bound_rg_ids Sequence[str]
    A list of resource groups that the access is restricted to
    bound_spids Sequence[str]
    A list of service principal IDs that the access is restricted to
    bound_sub_ids Sequence[str]
    A list of subscription ids that the access is restricted to
    custom_audience str
    The audience in the JWT
    custom_issuer str
    Issuer URL
    jwks_uri str
    The URL to the JSON Web Key Set (JWKS) that containing the public keys that should be used to verify any JSON Web Token (JWT) issued by the authorization server
    boundTenantId String
    The Azure tenant id that the access is restricted to
    boundGroupIds List<String>
    A list of group ids that the access is restricted to
    boundProviders List<String>
    A list of resource providers that the access is restricted to (e.g, Microsoft.Compute, Microsoft.ManagedIdentity, etc)
    boundResourceIds List<String>
    A list of full resource ids that the access is restricted to
    boundResourceNames List<String>
    A list of resource names that the access is restricted to (e.g, a virtual machine name, scale set name, etc)
    boundResourceTypes List<String>
    A list of resource types that the access is restricted to (e.g, virtualMachines, userAssignedIdentities, etc)
    boundRgIds List<String>
    A list of resource groups that the access is restricted to
    boundSpids List<String>
    A list of service principal IDs that the access is restricted to
    boundSubIds List<String>
    A list of subscription ids that the access is restricted to
    customAudience String
    The audience in the JWT
    customIssuer String
    Issuer URL
    jwksUri String
    The URL to the JSON Web Key Set (JWKS) that containing the public keys that should be used to verify any JSON Web Token (JWT) issued by the authorization server

    AuthMethodGcp, AuthMethodGcpArgs

    ServiceAccountCredsData string
    Service Account creds data, base64 encoded
    Audience string
    The audience to verify in the JWT received by the client
    Gces List<AuthMethodGcpGce>
    IAM GCE Auth Method
    Iams List<AuthMethodGcpIam>
    IAM GCP Auth Method
    ServiceAccountCredsData string
    Service Account creds data, base64 encoded
    Audience string
    The audience to verify in the JWT received by the client
    Gces []AuthMethodGcpGce
    IAM GCE Auth Method
    Iams []AuthMethodGcpIam
    IAM GCP Auth Method
    serviceAccountCredsData String
    Service Account creds data, base64 encoded
    audience String
    The audience to verify in the JWT received by the client
    gces List<AuthMethodGcpGce>
    IAM GCE Auth Method
    iams List<AuthMethodGcpIam>
    IAM GCP Auth Method
    serviceAccountCredsData string
    Service Account creds data, base64 encoded
    audience string
    The audience to verify in the JWT received by the client
    gces AuthMethodGcpGce[]
    IAM GCE Auth Method
    iams AuthMethodGcpIam[]
    IAM GCP Auth Method
    service_account_creds_data str
    Service Account creds data, base64 encoded
    audience str
    The audience to verify in the JWT received by the client
    gces Sequence[AuthMethodGcpGce]
    IAM GCE Auth Method
    iams Sequence[AuthMethodGcpIam]
    IAM GCP Auth Method
    serviceAccountCredsData String
    Service Account creds data, base64 encoded
    audience String
    The audience to verify in the JWT received by the client
    gces List<Property Map>
    IAM GCE Auth Method
    iams List<Property Map>
    IAM GCP Auth Method

    AuthMethodGcpGce, AuthMethodGcpGceArgs

    BoundLabels List<string>
    GCE only. A list of GCP labels formatted as "key:value" pairs that must be set on instances in order to authenticate
    BoundRegions List<string>
    GCE only. A list of regions. GCE instances must belong to any of the provided regions in order to authenticate
    BoundZones List<string>
    GCE only. A list of zones. GCE instances must belong to any of the provided zones in order to authenticate
    BoundLabels []string
    GCE only. A list of GCP labels formatted as "key:value" pairs that must be set on instances in order to authenticate
    BoundRegions []string
    GCE only. A list of regions. GCE instances must belong to any of the provided regions in order to authenticate
    BoundZones []string
    GCE only. A list of zones. GCE instances must belong to any of the provided zones in order to authenticate
    boundLabels List<String>
    GCE only. A list of GCP labels formatted as "key:value" pairs that must be set on instances in order to authenticate
    boundRegions List<String>
    GCE only. A list of regions. GCE instances must belong to any of the provided regions in order to authenticate
    boundZones List<String>
    GCE only. A list of zones. GCE instances must belong to any of the provided zones in order to authenticate
    boundLabels string[]
    GCE only. A list of GCP labels formatted as "key:value" pairs that must be set on instances in order to authenticate
    boundRegions string[]
    GCE only. A list of regions. GCE instances must belong to any of the provided regions in order to authenticate
    boundZones string[]
    GCE only. A list of zones. GCE instances must belong to any of the provided zones in order to authenticate
    bound_labels Sequence[str]
    GCE only. A list of GCP labels formatted as "key:value" pairs that must be set on instances in order to authenticate
    bound_regions Sequence[str]
    GCE only. A list of regions. GCE instances must belong to any of the provided regions in order to authenticate
    bound_zones Sequence[str]
    GCE only. A list of zones. GCE instances must belong to any of the provided zones in order to authenticate
    boundLabels List<String>
    GCE only. A list of GCP labels formatted as "key:value" pairs that must be set on instances in order to authenticate
    boundRegions List<String>
    GCE only. A list of regions. GCE instances must belong to any of the provided regions in order to authenticate
    boundZones List<String>
    GCE only. A list of zones. GCE instances must belong to any of the provided zones in order to authenticate

    AuthMethodGcpIam, AuthMethodGcpIamArgs

    BoundServiceAccounts List<string>
    IAM only. A list of Service Accounts. Clients must belong to any of the provided service accounts in order to authenticate
    BoundServiceAccounts []string
    IAM only. A list of Service Accounts. Clients must belong to any of the provided service accounts in order to authenticate
    boundServiceAccounts List<String>
    IAM only. A list of Service Accounts. Clients must belong to any of the provided service accounts in order to authenticate
    boundServiceAccounts string[]
    IAM only. A list of Service Accounts. Clients must belong to any of the provided service accounts in order to authenticate
    bound_service_accounts Sequence[str]
    IAM only. A list of Service Accounts. Clients must belong to any of the provided service accounts in order to authenticate
    boundServiceAccounts List<String>
    IAM only. A list of Service Accounts. Clients must belong to any of the provided service accounts in order to authenticate

    AuthMethodSaml, AuthMethodSamlArgs

    UniqueIdentifier string
    A unique identifier (ID) value should be configured for OAuth2, LDAP and SAML authentication method types and is usually a value such as the email, username, or upn for example
    IdpMetadataUrl string
    IDP metadata url
    IdpMetadataXmlData string
    IDP metadata xml data
    UniqueIdentifier string
    A unique identifier (ID) value should be configured for OAuth2, LDAP and SAML authentication method types and is usually a value such as the email, username, or upn for example
    IdpMetadataUrl string
    IDP metadata url
    IdpMetadataXmlData string
    IDP metadata xml data
    uniqueIdentifier String
    A unique identifier (ID) value should be configured for OAuth2, LDAP and SAML authentication method types and is usually a value such as the email, username, or upn for example
    idpMetadataUrl String
    IDP metadata url
    idpMetadataXmlData String
    IDP metadata xml data
    uniqueIdentifier string
    A unique identifier (ID) value should be configured for OAuth2, LDAP and SAML authentication method types and is usually a value such as the email, username, or upn for example
    idpMetadataUrl string
    IDP metadata url
    idpMetadataXmlData string
    IDP metadata xml data
    unique_identifier str
    A unique identifier (ID) value should be configured for OAuth2, LDAP and SAML authentication method types and is usually a value such as the email, username, or upn for example
    idp_metadata_url str
    IDP metadata url
    idp_metadata_xml_data str
    IDP metadata xml data
    uniqueIdentifier String
    A unique identifier (ID) value should be configured for OAuth2, LDAP and SAML authentication method types and is usually a value such as the email, username, or upn for example
    idpMetadataUrl String
    IDP metadata url
    idpMetadataXmlData String
    IDP metadata xml data

    Import

    $ pulumi import akeyless:index/authMethod:AuthMethod example /full-auth-method-path/and-name-in-akeyless

    To learn more about importing existing cloud resources, see Importing resources.

    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