1. Packages
  2. Packages
  3. Akeyless Provider
  4. API Docs
  5. AuthMethodSaml
Viewing docs for akeyless 2.0.1
published on Monday, Apr 27, 2026 by akeyless-community
Schema (JSON)
akeyless-community/terraform-provider-akeyless

akeyless.AuthMethodSaml

Viewing docs for akeyless 2.0.1
published on Monday, Apr 27, 2026 by akeyless-community
Schema (JSON)
akeyless-community/terraform-provider-akeyless

    SAML Auth Method Resource

    Create AuthMethodSaml Resource

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

    Constructor syntax

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

@overload
def AuthMethodSaml(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   unique_identifier: Optional[str] = None,
                   expiration_event_ins: Optional[Sequence[str]] = None,
                   gw_bound_ips: Optional[Sequence[str]] = None,
                   audit_logs_claims: Optional[Sequence[str]] = None,
                   auth_method_saml_id: Optional[str] = None,
                   bound_ips: Optional[Sequence[str]] = None,
                   delete_protection: Optional[str] = None,
                   description: Optional[str] = None,
                   access_expires: Optional[float] = None,
                   allowed_redirect_uris: Optional[Sequence[str]] = None,
                   idp_metadata_url: Optional[str] = None,
                   force_sub_claims: Optional[bool] = None,
                   idp_metadata_xml_data: Optional[str] = None,
                   jwt_ttl: Optional[float] = None,
                   name: Optional[str] = None,
                   product_types: Optional[Sequence[str]] = None,
                   subclaims_delimiters: Optional[Sequence[str]] = None,
                   allowed_client_types: Optional[Sequence[str]] = None)
    func NewAuthMethodSaml(ctx *Context, name string, args AuthMethodSamlArgs, opts ...ResourceOption) (*AuthMethodSaml, error)
    public AuthMethodSaml(string name, AuthMethodSamlArgs args, CustomResourceOptions? opts = null)
    public AuthMethodSaml(String name, AuthMethodSamlArgs args)
public AuthMethodSaml(String name, AuthMethodSamlArgs args, CustomResourceOptions options)

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


    resource "akeyless_authmethodsaml" "name" {
    # resource properties
}

    Parameters

    name string
    The unique name of the resource.
    args AuthMethodSamlArgs
    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 AuthMethodSamlArgs
    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 AuthMethodSamlArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args AuthMethodSamlArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args AuthMethodSamlArgs
    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 authMethodSamlResource = new Akeyless.AuthMethodSaml("authMethodSamlResource", new()
{
    UniqueIdentifier = "string",
    ExpirationEventIns = new[]
    {
        "string",
    },
    GwBoundIps = new[]
    {
        "string",
    },
    AuditLogsClaims = new[]
    {
        "string",
    },
    AuthMethodSamlId = "string",
    BoundIps = new[]
    {
        "string",
    },
    DeleteProtection = "string",
    Description = "string",
    AccessExpires = 0,
    AllowedRedirectUris = new[]
    {
        "string",
    },
    IdpMetadataUrl = "string",
    ForceSubClaims = false,
    IdpMetadataXmlData = "string",
    JwtTtl = 0,
    Name = "string",
    ProductTypes = new[]
    {
        "string",
    },
    SubclaimsDelimiters = new[]
    {
        "string",
    },
    AllowedClientTypes = new[]
    {
        "string",
    },
});

    example, err := akeyless.NewAuthMethodSaml(ctx, "authMethodSamlResource", &akeyless.AuthMethodSamlArgs{
	UniqueIdentifier: pulumi.String("string"),
	ExpirationEventIns: pulumi.StringArray{
		pulumi.String("string"),
	},
	GwBoundIps: pulumi.StringArray{
		pulumi.String("string"),
	},
	AuditLogsClaims: pulumi.StringArray{
		pulumi.String("string"),
	},
	AuthMethodSamlId: pulumi.String("string"),
	BoundIps: pulumi.StringArray{
		pulumi.String("string"),
	},
	DeleteProtection: pulumi.String("string"),
	Description:      pulumi.String("string"),
	AccessExpires:    pulumi.Float64(0),
	AllowedRedirectUris: pulumi.StringArray{
		pulumi.String("string"),
	},
	IdpMetadataUrl:     pulumi.String("string"),
	ForceSubClaims:     pulumi.Bool(false),
	IdpMetadataXmlData: pulumi.String("string"),
	JwtTtl:             pulumi.Float64(0),
	Name:               pulumi.String("string"),
	ProductTypes: pulumi.StringArray{
		pulumi.String("string"),
	},
	SubclaimsDelimiters: pulumi.StringArray{
		pulumi.String("string"),
	},
	AllowedClientTypes: pulumi.StringArray{
		pulumi.String("string"),
	},
})

    resource "akeyless_authmethodsaml" "authMethodSamlResource" {
  unique_identifier     = "string"
  expiration_event_ins  = ["string"]
  gw_bound_ips          = ["string"]
  audit_logs_claims     = ["string"]
  auth_method_saml_id   = "string"
  bound_ips             = ["string"]
  delete_protection     = "string"
  description           = "string"
  access_expires        = 0
  allowed_redirect_uris = ["string"]
  idp_metadata_url      = "string"
  force_sub_claims      = false
  idp_metadata_xml_data = "string"
  jwt_ttl               = 0
  name                  = "string"
  product_types         = ["string"]
  subclaims_delimiters  = ["string"]
  allowed_client_types  = ["string"]
}

    var authMethodSamlResource = new AuthMethodSaml("authMethodSamlResource", AuthMethodSamlArgs.builder()
    .uniqueIdentifier("string")
    .expirationEventIns("string")
    .gwBoundIps("string")
    .auditLogsClaims("string")
    .authMethodSamlId("string")
    .boundIps("string")
    .deleteProtection("string")
    .description("string")
    .accessExpires(0.0)
    .allowedRedirectUris("string")
    .idpMetadataUrl("string")
    .forceSubClaims(false)
    .idpMetadataXmlData("string")
    .jwtTtl(0.0)
    .name("string")
    .productTypes("string")
    .subclaimsDelimiters("string")
    .allowedClientTypes("string")
    .build());

    auth_method_saml_resource = akeyless.AuthMethodSaml("authMethodSamlResource",
    unique_identifier="string",
    expiration_event_ins=["string"],
    gw_bound_ips=["string"],
    audit_logs_claims=["string"],
    auth_method_saml_id="string",
    bound_ips=["string"],
    delete_protection="string",
    description="string",
    access_expires=float(0),
    allowed_redirect_uris=["string"],
    idp_metadata_url="string",
    force_sub_claims=False,
    idp_metadata_xml_data="string",
    jwt_ttl=float(0),
    name="string",
    product_types=["string"],
    subclaims_delimiters=["string"],
    allowed_client_types=["string"])

    const authMethodSamlResource = new akeyless.AuthMethodSaml("authMethodSamlResource", {
    uniqueIdentifier: "string",
    expirationEventIns: ["string"],
    gwBoundIps: ["string"],
    auditLogsClaims: ["string"],
    authMethodSamlId: "string",
    boundIps: ["string"],
    deleteProtection: "string",
    description: "string",
    accessExpires: 0,
    allowedRedirectUris: ["string"],
    idpMetadataUrl: "string",
    forceSubClaims: false,
    idpMetadataXmlData: "string",
    jwtTtl: 0,
    name: "string",
    productTypes: ["string"],
    subclaimsDelimiters: ["string"],
    allowedClientTypes: ["string"],
});

    type: akeyless:AuthMethodSaml
properties:
    accessExpires: 0
    allowedClientTypes:
        - string
    allowedRedirectUris:
        - string
    auditLogsClaims:
        - string
    authMethodSamlId: string
    boundIps:
        - string
    deleteProtection: string
    description: string
    expirationEventIns:
        - string
    forceSubClaims: false
    gwBoundIps:
        - string
    idpMetadataUrl: string
    idpMetadataXmlData: string
    jwtTtl: 0
    name: string
    productTypes:
        - string
    subclaimsDelimiters:
        - string
    uniqueIdentifier: string

    AuthMethodSaml 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 AuthMethodSaml resource accepts the following input properties:

    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. Whenever a user logs in with a token, these authentication types issue a sub claim that contains details uniquely identifying that user. This sub claim includes a key containing the ID value that you configured, and is used to distinguish between different users from within the same organization.
    AccessExpires double
    Access expiration date in Unix timestamp (select 0 for access without expiry date)
    AllowedClientTypes List<string>
    Limit the auth method usage for specific client types [cli,ui,gateway-admin,sdk,mobile,extension]
    AllowedRedirectUris List<string>
    Allowed redirect URIs after the authentication
    AuditLogsClaims List<string>
    Subclaims to include in audit logs, e.g "--audit-logs-claims email --audit-logs-claims username"
    AuthMethodSamlId string
    The ID of this resource.
    BoundIps List<string>
    A CIDR whitelist with the IPs that the access is restricted to
    DeleteProtection string
    Protection from accidental deletion of this auth method, [true/false]
    Description string
    Auth Method description
    ExpirationEventIns List<string>
    How many days before the expiration of the auth method would you like to be notified.
    ForceSubClaims bool
    if true: enforce role-association must include sub claims
    GwBoundIps List<string>
    A CIDR whitelist with the GW IPs that the access is restricted to
    IdpMetadataUrl string
    IDP metadata url
    IdpMetadataXmlData string
    IDP metadata xml data
    JwtTtl double
    Creds expiration time in minutes
    Name string
    Auth Method name
    ProductTypes List<string>
    Choose the relevant product type for the auth method [sm, sra, pm, dp, ca]
    SubclaimsDelimiters List<string>
    A list of additional sub claims delimiters (relevant only for SAML, OIDC, OAuth2/JWT)
    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. Whenever a user logs in with a token, these authentication types issue a sub claim that contains details uniquely identifying that user. This sub claim includes a key containing the ID value that you configured, and is used to distinguish between different users from within the same organization.
    AccessExpires float64
    Access expiration date in Unix timestamp (select 0 for access without expiry date)
    AllowedClientTypes []string
    Limit the auth method usage for specific client types [cli,ui,gateway-admin,sdk,mobile,extension]
    AllowedRedirectUris []string
    Allowed redirect URIs after the authentication
    AuditLogsClaims []string
    Subclaims to include in audit logs, e.g "--audit-logs-claims email --audit-logs-claims username"
    AuthMethodSamlId string
    The ID of this resource.
    BoundIps []string
    A CIDR whitelist with the IPs that the access is restricted to
    DeleteProtection string
    Protection from accidental deletion of this auth method, [true/false]
    Description string
    Auth Method description
    ExpirationEventIns []string
    How many days before the expiration of the auth method would you like to be notified.
    ForceSubClaims bool
    if true: enforce role-association must include sub claims
    GwBoundIps []string
    A CIDR whitelist with the GW IPs that the access is restricted to
    IdpMetadataUrl string
    IDP metadata url
    IdpMetadataXmlData string
    IDP metadata xml data
    JwtTtl float64
    Creds expiration time in minutes
    Name string
    Auth Method name
    ProductTypes []string
    Choose the relevant product type for the auth method [sm, sra, pm, dp, ca]
    SubclaimsDelimiters []string
    A list of additional sub claims delimiters (relevant only for SAML, OIDC, OAuth2/JWT)
    unique_identifier 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. Whenever a user logs in with a token, these authentication types issue a sub claim that contains details uniquely identifying that user. This sub claim includes a key containing the ID value that you configured, and is used to distinguish between different users from within the same organization.
    access_expires number
    Access expiration date in Unix timestamp (select 0 for access without expiry date)
    allowed_client_types list(string)
    Limit the auth method usage for specific client types [cli,ui,gateway-admin,sdk,mobile,extension]
    allowed_redirect_uris list(string)
    Allowed redirect URIs after the authentication
    audit_logs_claims list(string)
    Subclaims to include in audit logs, e.g "--audit-logs-claims email --audit-logs-claims username"
    auth_method_saml_id string
    The ID of this resource.
    bound_ips list(string)
    A CIDR whitelist with the IPs that the access is restricted to
    delete_protection string
    Protection from accidental deletion of this auth method, [true/false]
    description string
    Auth Method description
    expiration_event_ins list(string)
    How many days before the expiration of the auth method would you like to be notified.
    force_sub_claims bool
    if true: enforce role-association must include sub claims
    gw_bound_ips list(string)
    A CIDR whitelist with the GW IPs that the access is restricted to
    idp_metadata_url string
    IDP metadata url
    idp_metadata_xml_data string
    IDP metadata xml data
    jwt_ttl number
    Creds expiration time in minutes
    name string
    Auth Method name
    product_types list(string)
    Choose the relevant product type for the auth method [sm, sra, pm, dp, ca]
    subclaims_delimiters list(string)
    A list of additional sub claims delimiters (relevant only for SAML, OIDC, OAuth2/JWT)
    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. Whenever a user logs in with a token, these authentication types issue a sub claim that contains details uniquely identifying that user. This sub claim includes a key containing the ID value that you configured, and is used to distinguish between different users from within the same organization.
    accessExpires Double
    Access expiration date in Unix timestamp (select 0 for access without expiry date)
    allowedClientTypes List<String>
    Limit the auth method usage for specific client types [cli,ui,gateway-admin,sdk,mobile,extension]
    allowedRedirectUris List<String>
    Allowed redirect URIs after the authentication
    auditLogsClaims List<String>
    Subclaims to include in audit logs, e.g "--audit-logs-claims email --audit-logs-claims username"
    authMethodSamlId String
    The ID of this resource.
    boundIps List<String>
    A CIDR whitelist with the IPs that the access is restricted to
    deleteProtection String
    Protection from accidental deletion of this auth method, [true/false]
    description String
    Auth Method description
    expirationEventIns List<String>
    How many days before the expiration of the auth method would you like to be notified.
    forceSubClaims Boolean
    if true: enforce role-association must include sub claims
    gwBoundIps List<String>
    A CIDR whitelist with the GW IPs that the access is restricted to
    idpMetadataUrl String
    IDP metadata url
    idpMetadataXmlData String
    IDP metadata xml data
    jwtTtl Double
    Creds expiration time in minutes
    name String
    Auth Method name
    productTypes List<String>
    Choose the relevant product type for the auth method [sm, sra, pm, dp, ca]
    subclaimsDelimiters List<String>
    A list of additional sub claims delimiters (relevant only for SAML, OIDC, OAuth2/JWT)
    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. Whenever a user logs in with a token, these authentication types issue a sub claim that contains details uniquely identifying that user. This sub claim includes a key containing the ID value that you configured, and is used to distinguish between different users from within the same organization.
    accessExpires number
    Access expiration date in Unix timestamp (select 0 for access without expiry date)
    allowedClientTypes string[]
    Limit the auth method usage for specific client types [cli,ui,gateway-admin,sdk,mobile,extension]
    allowedRedirectUris string[]
    Allowed redirect URIs after the authentication
    auditLogsClaims string[]
    Subclaims to include in audit logs, e.g "--audit-logs-claims email --audit-logs-claims username"
    authMethodSamlId string
    The ID of this resource.
    boundIps string[]
    A CIDR whitelist with the IPs that the access is restricted to
    deleteProtection string
    Protection from accidental deletion of this auth method, [true/false]
    description string
    Auth Method description
    expirationEventIns string[]
    How many days before the expiration of the auth method would you like to be notified.
    forceSubClaims boolean
    if true: enforce role-association must include sub claims
    gwBoundIps string[]
    A CIDR whitelist with the GW IPs that the access is restricted to
    idpMetadataUrl string
    IDP metadata url
    idpMetadataXmlData string
    IDP metadata xml data
    jwtTtl number
    Creds expiration time in minutes
    name string
    Auth Method name
    productTypes string[]
    Choose the relevant product type for the auth method [sm, sra, pm, dp, ca]
    subclaimsDelimiters string[]
    A list of additional sub claims delimiters (relevant only for SAML, OIDC, OAuth2/JWT)
    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. Whenever a user logs in with a token, these authentication types issue a sub claim that contains details uniquely identifying that user. This sub claim includes a key containing the ID value that you configured, and is used to distinguish between different users from within the same organization.
    access_expires float
    Access expiration date in Unix timestamp (select 0 for access without expiry date)
    allowed_client_types Sequence[str]
    Limit the auth method usage for specific client types [cli,ui,gateway-admin,sdk,mobile,extension]
    allowed_redirect_uris Sequence[str]
    Allowed redirect URIs after the authentication
    audit_logs_claims Sequence[str]
    Subclaims to include in audit logs, e.g "--audit-logs-claims email --audit-logs-claims username"
    auth_method_saml_id str
    The ID of this resource.
    bound_ips Sequence[str]
    A CIDR whitelist with the IPs that the access is restricted to
    delete_protection str
    Protection from accidental deletion of this auth method, [true/false]
    description str
    Auth Method description
    expiration_event_ins Sequence[str]
    How many days before the expiration of the auth method would you like to be notified.
    force_sub_claims bool
    if true: enforce role-association must include sub claims
    gw_bound_ips Sequence[str]
    A CIDR whitelist with the GW IPs that the access is restricted to
    idp_metadata_url str
    IDP metadata url
    idp_metadata_xml_data str
    IDP metadata xml data
    jwt_ttl float
    Creds expiration time in minutes
    name str
    Auth Method name
    product_types Sequence[str]
    Choose the relevant product type for the auth method [sm, sra, pm, dp, ca]
    subclaims_delimiters Sequence[str]
    A list of additional sub claims delimiters (relevant only for SAML, OIDC, OAuth2/JWT)
    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. Whenever a user logs in with a token, these authentication types issue a sub claim that contains details uniquely identifying that user. This sub claim includes a key containing the ID value that you configured, and is used to distinguish between different users from within the same organization.
    accessExpires Number
    Access expiration date in Unix timestamp (select 0 for access without expiry date)
    allowedClientTypes List<String>
    Limit the auth method usage for specific client types [cli,ui,gateway-admin,sdk,mobile,extension]
    allowedRedirectUris List<String>
    Allowed redirect URIs after the authentication
    auditLogsClaims List<String>
    Subclaims to include in audit logs, e.g "--audit-logs-claims email --audit-logs-claims username"
    authMethodSamlId String
    The ID of this resource.
    boundIps List<String>
    A CIDR whitelist with the IPs that the access is restricted to
    deleteProtection String
    Protection from accidental deletion of this auth method, [true/false]
    description String
    Auth Method description
    expirationEventIns List<String>
    How many days before the expiration of the auth method would you like to be notified.
    forceSubClaims Boolean
    if true: enforce role-association must include sub claims
    gwBoundIps List<String>
    A CIDR whitelist with the GW IPs that the access is restricted to
    idpMetadataUrl String
    IDP metadata url
    idpMetadataXmlData String
    IDP metadata xml data
    jwtTtl Number
    Creds expiration time in minutes
    name String
    Auth Method name
    productTypes List<String>
    Choose the relevant product type for the auth method [sm, sra, pm, dp, ca]
    subclaimsDelimiters List<String>
    A list of additional sub claims delimiters (relevant only for SAML, OIDC, OAuth2/JWT)

    Outputs

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

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

    Look up Existing AuthMethodSaml Resource

    Get an existing AuthMethodSaml 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?: AuthMethodSamlState, opts?: CustomResourceOptions): AuthMethodSaml
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        access_expires: Optional[float] = None,
        access_id: Optional[str] = None,
        allowed_client_types: Optional[Sequence[str]] = None,
        allowed_redirect_uris: Optional[Sequence[str]] = None,
        audit_logs_claims: Optional[Sequence[str]] = None,
        auth_method_saml_id: Optional[str] = None,
        bound_ips: Optional[Sequence[str]] = None,
        delete_protection: Optional[str] = None,
        description: Optional[str] = None,
        expiration_event_ins: Optional[Sequence[str]] = None,
        force_sub_claims: Optional[bool] = None,
        gw_bound_ips: Optional[Sequence[str]] = None,
        idp_metadata_url: Optional[str] = None,
        idp_metadata_xml_data: Optional[str] = None,
        jwt_ttl: Optional[float] = None,
        name: Optional[str] = None,
        product_types: Optional[Sequence[str]] = None,
        subclaims_delimiters: Optional[Sequence[str]] = None,
        unique_identifier: Optional[str] = None) -> AuthMethodSaml
    func GetAuthMethodSaml(ctx *Context, name string, id IDInput, state *AuthMethodSamlState, opts ...ResourceOption) (*AuthMethodSaml, error)
    public static AuthMethodSaml Get(string name, Input<string> id, AuthMethodSamlState? state, CustomResourceOptions? opts = null)
    public static AuthMethodSaml get(String name, Output<String> id, AuthMethodSamlState state, CustomResourceOptions options)
    resources:  _:    type: akeyless:AuthMethodSaml    get:      id: ${id}
    import {
  to = akeyless_authmethodsaml.example
  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
    AllowedClientTypes List<string>
    Limit the auth method usage for specific client types [cli,ui,gateway-admin,sdk,mobile,extension]
    AllowedRedirectUris List<string>
    Allowed redirect URIs after the authentication
    AuditLogsClaims List<string>
    Subclaims to include in audit logs, e.g "--audit-logs-claims email --audit-logs-claims username"
    AuthMethodSamlId string
    The ID of this resource.
    BoundIps List<string>
    A CIDR whitelist with the IPs that the access is restricted to
    DeleteProtection string
    Protection from accidental deletion of this auth method, [true/false]
    Description string
    Auth Method description
    ExpirationEventIns List<string>
    How many days before the expiration of the auth method would you like to be notified.
    ForceSubClaims bool
    if true: enforce role-association must include sub claims
    GwBoundIps List<string>
    A CIDR whitelist with the GW IPs that the access is restricted to
    IdpMetadataUrl string
    IDP metadata url
    IdpMetadataXmlData string
    IDP metadata xml data
    JwtTtl double
    Creds expiration time in minutes
    Name string
    Auth Method name
    ProductTypes List<string>
    Choose the relevant product type for the auth method [sm, sra, pm, dp, ca]
    SubclaimsDelimiters List<string>
    A list of additional sub claims delimiters (relevant only for SAML, OIDC, OAuth2/JWT)
    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. Whenever a user logs in with a token, these authentication types issue a sub claim that contains details uniquely identifying that user. This sub claim includes a key containing the ID value that you configured, and is used to distinguish between different users from within the same organization.
    AccessExpires float64
    Access expiration date in Unix timestamp (select 0 for access without expiry date)
    AccessId string
    Auth Method access ID
    AllowedClientTypes []string
    Limit the auth method usage for specific client types [cli,ui,gateway-admin,sdk,mobile,extension]
    AllowedRedirectUris []string
    Allowed redirect URIs after the authentication
    AuditLogsClaims []string
    Subclaims to include in audit logs, e.g "--audit-logs-claims email --audit-logs-claims username"
    AuthMethodSamlId string
    The ID of this resource.
    BoundIps []string
    A CIDR whitelist with the IPs that the access is restricted to
    DeleteProtection string
    Protection from accidental deletion of this auth method, [true/false]
    Description string
    Auth Method description
    ExpirationEventIns []string
    How many days before the expiration of the auth method would you like to be notified.
    ForceSubClaims bool
    if true: enforce role-association must include sub claims
    GwBoundIps []string
    A CIDR whitelist with the GW IPs that the access is restricted to
    IdpMetadataUrl string
    IDP metadata url
    IdpMetadataXmlData string
    IDP metadata xml data
    JwtTtl float64
    Creds expiration time in minutes
    Name string
    Auth Method name
    ProductTypes []string
    Choose the relevant product type for the auth method [sm, sra, pm, dp, ca]
    SubclaimsDelimiters []string
    A list of additional sub claims delimiters (relevant only for SAML, OIDC, OAuth2/JWT)
    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. Whenever a user logs in with a token, these authentication types issue a sub claim that contains details uniquely identifying that user. This sub claim includes a key containing the ID value that you configured, and is used to distinguish between different users from within the same organization.
    access_expires number
    Access expiration date in Unix timestamp (select 0 for access without expiry date)
    access_id string
    Auth Method access ID
    allowed_client_types list(string)
    Limit the auth method usage for specific client types [cli,ui,gateway-admin,sdk,mobile,extension]
    allowed_redirect_uris list(string)
    Allowed redirect URIs after the authentication
    audit_logs_claims list(string)
    Subclaims to include in audit logs, e.g "--audit-logs-claims email --audit-logs-claims username"
    auth_method_saml_id string
    The ID of this resource.
    bound_ips list(string)
    A CIDR whitelist with the IPs that the access is restricted to
    delete_protection string
    Protection from accidental deletion of this auth method, [true/false]
    description string
    Auth Method description
    expiration_event_ins list(string)
    How many days before the expiration of the auth method would you like to be notified.
    force_sub_claims bool
    if true: enforce role-association must include sub claims
    gw_bound_ips list(string)
    A CIDR whitelist with the GW IPs that the access is restricted to
    idp_metadata_url string
    IDP metadata url
    idp_metadata_xml_data string
    IDP metadata xml data
    jwt_ttl number
    Creds expiration time in minutes
    name string
    Auth Method name
    product_types list(string)
    Choose the relevant product type for the auth method [sm, sra, pm, dp, ca]
    subclaims_delimiters list(string)
    A list of additional sub claims delimiters (relevant only for SAML, OIDC, OAuth2/JWT)
    unique_identifier 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. Whenever a user logs in with a token, these authentication types issue a sub claim that contains details uniquely identifying that user. This sub claim includes a key containing the ID value that you configured, and is used to distinguish between different users from within the same organization.
    accessExpires Double
    Access expiration date in Unix timestamp (select 0 for access without expiry date)
    accessId String
    Auth Method access ID
    allowedClientTypes List<String>
    Limit the auth method usage for specific client types [cli,ui,gateway-admin,sdk,mobile,extension]
    allowedRedirectUris List<String>
    Allowed redirect URIs after the authentication
    auditLogsClaims List<String>
    Subclaims to include in audit logs, e.g "--audit-logs-claims email --audit-logs-claims username"
    authMethodSamlId String
    The ID of this resource.
    boundIps List<String>
    A CIDR whitelist with the IPs that the access is restricted to
    deleteProtection String
    Protection from accidental deletion of this auth method, [true/false]
    description String
    Auth Method description
    expirationEventIns List<String>
    How many days before the expiration of the auth method would you like to be notified.
    forceSubClaims Boolean
    if true: enforce role-association must include sub claims
    gwBoundIps List<String>
    A CIDR whitelist with the GW IPs that the access is restricted to
    idpMetadataUrl String
    IDP metadata url
    idpMetadataXmlData String
    IDP metadata xml data
    jwtTtl Double
    Creds expiration time in minutes
    name String
    Auth Method name
    productTypes List<String>
    Choose the relevant product type for the auth method [sm, sra, pm, dp, ca]
    subclaimsDelimiters List<String>
    A list of additional sub claims delimiters (relevant only for SAML, OIDC, OAuth2/JWT)
    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. Whenever a user logs in with a token, these authentication types issue a sub claim that contains details uniquely identifying that user. This sub claim includes a key containing the ID value that you configured, and is used to distinguish between different users from within the same organization.
    accessExpires number
    Access expiration date in Unix timestamp (select 0 for access without expiry date)
    accessId string
    Auth Method access ID
    allowedClientTypes string[]
    Limit the auth method usage for specific client types [cli,ui,gateway-admin,sdk,mobile,extension]
    allowedRedirectUris string[]
    Allowed redirect URIs after the authentication
    auditLogsClaims string[]
    Subclaims to include in audit logs, e.g "--audit-logs-claims email --audit-logs-claims username"
    authMethodSamlId string
    The ID of this resource.
    boundIps string[]
    A CIDR whitelist with the IPs that the access is restricted to
    deleteProtection string
    Protection from accidental deletion of this auth method, [true/false]
    description string
    Auth Method description
    expirationEventIns string[]
    How many days before the expiration of the auth method would you like to be notified.
    forceSubClaims boolean
    if true: enforce role-association must include sub claims
    gwBoundIps string[]
    A CIDR whitelist with the GW IPs that the access is restricted to
    idpMetadataUrl string
    IDP metadata url
    idpMetadataXmlData string
    IDP metadata xml data
    jwtTtl number
    Creds expiration time in minutes
    name string
    Auth Method name
    productTypes string[]
    Choose the relevant product type for the auth method [sm, sra, pm, dp, ca]
    subclaimsDelimiters string[]
    A list of additional sub claims delimiters (relevant only for SAML, OIDC, OAuth2/JWT)
    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. Whenever a user logs in with a token, these authentication types issue a sub claim that contains details uniquely identifying that user. This sub claim includes a key containing the ID value that you configured, and is used to distinguish between different users from within the same organization.
    access_expires float
    Access expiration date in Unix timestamp (select 0 for access without expiry date)
    access_id str
    Auth Method access ID
    allowed_client_types Sequence[str]
    Limit the auth method usage for specific client types [cli,ui,gateway-admin,sdk,mobile,extension]
    allowed_redirect_uris Sequence[str]
    Allowed redirect URIs after the authentication
    audit_logs_claims Sequence[str]
    Subclaims to include in audit logs, e.g "--audit-logs-claims email --audit-logs-claims username"
    auth_method_saml_id str
    The ID of this resource.
    bound_ips Sequence[str]
    A CIDR whitelist with the IPs that the access is restricted to
    delete_protection str
    Protection from accidental deletion of this auth method, [true/false]
    description str
    Auth Method description
    expiration_event_ins Sequence[str]
    How many days before the expiration of the auth method would you like to be notified.
    force_sub_claims bool
    if true: enforce role-association must include sub claims
    gw_bound_ips Sequence[str]
    A CIDR whitelist with the GW IPs that the access is restricted to
    idp_metadata_url str
    IDP metadata url
    idp_metadata_xml_data str
    IDP metadata xml data
    jwt_ttl float
    Creds expiration time in minutes
    name str
    Auth Method name
    product_types Sequence[str]
    Choose the relevant product type for the auth method [sm, sra, pm, dp, ca]
    subclaims_delimiters Sequence[str]
    A list of additional sub claims delimiters (relevant only for SAML, OIDC, OAuth2/JWT)
    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. Whenever a user logs in with a token, these authentication types issue a sub claim that contains details uniquely identifying that user. This sub claim includes a key containing the ID value that you configured, and is used to distinguish between different users from within the same organization.
    accessExpires Number
    Access expiration date in Unix timestamp (select 0 for access without expiry date)
    accessId String
    Auth Method access ID
    allowedClientTypes List<String>
    Limit the auth method usage for specific client types [cli,ui,gateway-admin,sdk,mobile,extension]
    allowedRedirectUris List<String>
    Allowed redirect URIs after the authentication
    auditLogsClaims List<String>
    Subclaims to include in audit logs, e.g "--audit-logs-claims email --audit-logs-claims username"
    authMethodSamlId String
    The ID of this resource.
    boundIps List<String>
    A CIDR whitelist with the IPs that the access is restricted to
    deleteProtection String
    Protection from accidental deletion of this auth method, [true/false]
    description String
    Auth Method description
    expirationEventIns List<String>
    How many days before the expiration of the auth method would you like to be notified.
    forceSubClaims Boolean
    if true: enforce role-association must include sub claims
    gwBoundIps List<String>
    A CIDR whitelist with the GW IPs that the access is restricted to
    idpMetadataUrl String
    IDP metadata url
    idpMetadataXmlData String
    IDP metadata xml data
    jwtTtl Number
    Creds expiration time in minutes
    name String
    Auth Method name
    productTypes List<String>
    Choose the relevant product type for the auth method [sm, sra, pm, dp, ca]
    subclaimsDelimiters List<String>
    A list of additional sub claims delimiters (relevant only for SAML, OIDC, OAuth2/JWT)
    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. Whenever a user logs in with a token, these authentication types issue a sub claim that contains details uniquely identifying that user. This sub claim includes a key containing the ID value that you configured, and is used to distinguish between different users from within the same organization.

    Import

    $ pulumi import akeyless:index/authMethodSaml:AuthMethodSaml example /full-auth-method-saml-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.
    Viewing docs for akeyless 2.0.1
    published on Monday, Apr 27, 2026 by akeyless-community
    Schema (JSON)
    akeyless-community/terraform-provider-akeyless
      Try Pulumi Cloud free. Your team will thank you.