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

akeyless.AuthMethodOauth2

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

    AOAuth2 Auth Method Resource

    Create AuthMethodOauth2 Resource

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

    Constructor syntax

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

@overload
def AuthMethodOauth2(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     unique_identifier: Optional[str] = None,
                     description: Optional[str] = None,
                     force_sub_claims: Optional[bool] = None,
                     audit_logs_claims: Optional[Sequence[str]] = None,
                     auth_method_oauth2_id: Optional[str] = None,
                     bound_client_ids: Optional[Sequence[str]] = None,
                     bound_ips: Optional[Sequence[str]] = None,
                     cert: Optional[str] = None,
                     cert_file_data: Optional[str] = None,
                     delete_protection: Optional[str] = None,
                     gateway_url: Optional[str] = None,
                     audience: Optional[str] = None,
                     expiration_event_ins: Optional[Sequence[str]] = None,
                     access_expires: Optional[float] = None,
                     gw_bound_ips: Optional[Sequence[str]] = None,
                     issuer: Optional[str] = None,
                     jwks_json_data: Optional[str] = None,
                     jwks_uri: 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 NewAuthMethodOauth2(ctx *Context, name string, args AuthMethodOauth2Args, opts ...ResourceOption) (*AuthMethodOauth2, error)
    public AuthMethodOauth2(string name, AuthMethodOauth2Args args, CustomResourceOptions? opts = null)
    public AuthMethodOauth2(String name, AuthMethodOauth2Args args)
public AuthMethodOauth2(String name, AuthMethodOauth2Args args, CustomResourceOptions options)

    type: akeyless:AuthMethodOauth2
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 AuthMethodOauth2Args
    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 AuthMethodOauth2Args
    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 AuthMethodOauth2Args
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args AuthMethodOauth2Args
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args AuthMethodOauth2Args
    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 authMethodOauth2Resource = new Akeyless.AuthMethodOauth2("authMethodOauth2Resource", new()
{
    UniqueIdentifier = "string",
    Description = "string",
    ForceSubClaims = false,
    AuditLogsClaims = new[]
    {
        "string",
    },
    AuthMethodOauth2Id = "string",
    BoundClientIds = new[]
    {
        "string",
    },
    BoundIps = new[]
    {
        "string",
    },
    Cert = "string",
    CertFileData = "string",
    DeleteProtection = "string",
    GatewayUrl = "string",
    Audience = "string",
    ExpirationEventIns = new[]
    {
        "string",
    },
    AccessExpires = 0,
    GwBoundIps = new[]
    {
        "string",
    },
    Issuer = "string",
    JwksJsonData = "string",
    JwksUri = "string",
    JwtTtl = 0,
    Name = "string",
    ProductTypes = new[]
    {
        "string",
    },
    SubclaimsDelimiters = new[]
    {
        "string",
    },
    AllowedClientTypes = new[]
    {
        "string",
    },
});

    example, err := akeyless.NewAuthMethodOauth2(ctx, "authMethodOauth2Resource", &akeyless.AuthMethodOauth2Args{
	UniqueIdentifier: pulumi.String("string"),
	Description:      pulumi.String("string"),
	ForceSubClaims:   pulumi.Bool(false),
	AuditLogsClaims: pulumi.StringArray{
		pulumi.String("string"),
	},
	AuthMethodOauth2Id: pulumi.String("string"),
	BoundClientIds: pulumi.StringArray{
		pulumi.String("string"),
	},
	BoundIps: pulumi.StringArray{
		pulumi.String("string"),
	},
	Cert:             pulumi.String("string"),
	CertFileData:     pulumi.String("string"),
	DeleteProtection: pulumi.String("string"),
	GatewayUrl:       pulumi.String("string"),
	Audience:         pulumi.String("string"),
	ExpirationEventIns: pulumi.StringArray{
		pulumi.String("string"),
	},
	AccessExpires: pulumi.Float64(0),
	GwBoundIps: pulumi.StringArray{
		pulumi.String("string"),
	},
	Issuer:       pulumi.String("string"),
	JwksJsonData: pulumi.String("string"),
	JwksUri:      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"),
	},
})

    var authMethodOauth2Resource = new AuthMethodOauth2("authMethodOauth2Resource", AuthMethodOauth2Args.builder()
    .uniqueIdentifier("string")
    .description("string")
    .forceSubClaims(false)
    .auditLogsClaims("string")
    .authMethodOauth2Id("string")
    .boundClientIds("string")
    .boundIps("string")
    .cert("string")
    .certFileData("string")
    .deleteProtection("string")
    .gatewayUrl("string")
    .audience("string")
    .expirationEventIns("string")
    .accessExpires(0.0)
    .gwBoundIps("string")
    .issuer("string")
    .jwksJsonData("string")
    .jwksUri("string")
    .jwtTtl(0.0)
    .name("string")
    .productTypes("string")
    .subclaimsDelimiters("string")
    .allowedClientTypes("string")
    .build());

    auth_method_oauth2_resource = akeyless.AuthMethodOauth2("authMethodOauth2Resource",
    unique_identifier="string",
    description="string",
    force_sub_claims=False,
    audit_logs_claims=["string"],
    auth_method_oauth2_id="string",
    bound_client_ids=["string"],
    bound_ips=["string"],
    cert="string",
    cert_file_data="string",
    delete_protection="string",
    gateway_url="string",
    audience="string",
    expiration_event_ins=["string"],
    access_expires=float(0),
    gw_bound_ips=["string"],
    issuer="string",
    jwks_json_data="string",
    jwks_uri="string",
    jwt_ttl=float(0),
    name="string",
    product_types=["string"],
    subclaims_delimiters=["string"],
    allowed_client_types=["string"])

    const authMethodOauth2Resource = new akeyless.AuthMethodOauth2("authMethodOauth2Resource", {
    uniqueIdentifier: "string",
    description: "string",
    forceSubClaims: false,
    auditLogsClaims: ["string"],
    authMethodOauth2Id: "string",
    boundClientIds: ["string"],
    boundIps: ["string"],
    cert: "string",
    certFileData: "string",
    deleteProtection: "string",
    gatewayUrl: "string",
    audience: "string",
    expirationEventIns: ["string"],
    accessExpires: 0,
    gwBoundIps: ["string"],
    issuer: "string",
    jwksJsonData: "string",
    jwksUri: "string",
    jwtTtl: 0,
    name: "string",
    productTypes: ["string"],
    subclaimsDelimiters: ["string"],
    allowedClientTypes: ["string"],
});

    type: akeyless:AuthMethodOauth2
properties:
    accessExpires: 0
    allowedClientTypes:
        - string
    audience: string
    auditLogsClaims:
        - string
    authMethodOauth2Id: string
    boundClientIds:
        - string
    boundIps:
        - string
    cert: string
    certFileData: string
    deleteProtection: string
    description: string
    expirationEventIns:
        - string
    forceSubClaims: false
    gatewayUrl: string
    gwBoundIps:
        - string
    issuer: string
    jwksJsonData: string
    jwksUri: string
    jwtTtl: 0
    name: string
    productTypes:
        - string
    subclaimsDelimiters:
        - string
    uniqueIdentifier: string

    AuthMethodOauth2 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 AuthMethodOauth2 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]
    Audience string
    The audience in the JWT
    AuditLogsClaims List<string>
    Subclaims to include in audit logs, e.g "--audit-logs-claims email --audit-logs-claims username"
    AuthMethodOauth2Id string
    The ID of this resource.
    BoundClientIds List<string>
    The clients ids that the access is restricted to
    BoundIps List<string>
    A CIDR whitelist with the IPs that the access is restricted to
    Cert string
    CertificateFile Path to a file that contain the certificate in a PEM format.
    CertFileData string
    CertificateFileData PEM Certificate in a Base64 format.
    DeleteProtection string
    Protection from accidental deletion of this object [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
    GatewayUrl string
    Akeyless Gateway URL (Configuration Management port). Relevant only when the jwks-uri is accessible only from the gateway.
    GwBoundIps List<string>
    A CIDR whitelist with the GW IPs that the access is restricted to
    Issuer string
    Issuer URL
    JwksJsonData string
    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. base64 encoded string
    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.
    JwtTtl double
    Jwt TTL
    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]
    Audience string
    The audience in the JWT
    AuditLogsClaims []string
    Subclaims to include in audit logs, e.g "--audit-logs-claims email --audit-logs-claims username"
    AuthMethodOauth2Id string
    The ID of this resource.
    BoundClientIds []string
    The clients ids that the access is restricted to
    BoundIps []string
    A CIDR whitelist with the IPs that the access is restricted to
    Cert string
    CertificateFile Path to a file that contain the certificate in a PEM format.
    CertFileData string
    CertificateFileData PEM Certificate in a Base64 format.
    DeleteProtection string
    Protection from accidental deletion of this object [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
    GatewayUrl string
    Akeyless Gateway URL (Configuration Management port). Relevant only when the jwks-uri is accessible only from the gateway.
    GwBoundIps []string
    A CIDR whitelist with the GW IPs that the access is restricted to
    Issuer string
    Issuer URL
    JwksJsonData string
    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. base64 encoded string
    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.
    JwtTtl float64
    Jwt TTL
    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.
    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]
    audience String
    The audience in the JWT
    auditLogsClaims List<String>
    Subclaims to include in audit logs, e.g "--audit-logs-claims email --audit-logs-claims username"
    authMethodOauth2Id String
    The ID of this resource.
    boundClientIds List<String>
    The clients ids that the access is restricted to
    boundIps List<String>
    A CIDR whitelist with the IPs that the access is restricted to
    cert String
    CertificateFile Path to a file that contain the certificate in a PEM format.
    certFileData String
    CertificateFileData PEM Certificate in a Base64 format.
    deleteProtection String
    Protection from accidental deletion of this object [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
    gatewayUrl String
    Akeyless Gateway URL (Configuration Management port). Relevant only when the jwks-uri is accessible only from the gateway.
    gwBoundIps List<String>
    A CIDR whitelist with the GW IPs that the access is restricted to
    issuer String
    Issuer URL
    jwksJsonData String
    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. base64 encoded string
    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.
    jwtTtl Double
    Jwt TTL
    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]
    audience string
    The audience in the JWT
    auditLogsClaims string[]
    Subclaims to include in audit logs, e.g "--audit-logs-claims email --audit-logs-claims username"
    authMethodOauth2Id string
    The ID of this resource.
    boundClientIds string[]
    The clients ids that the access is restricted to
    boundIps string[]
    A CIDR whitelist with the IPs that the access is restricted to
    cert string
    CertificateFile Path to a file that contain the certificate in a PEM format.
    certFileData string
    CertificateFileData PEM Certificate in a Base64 format.
    deleteProtection string
    Protection from accidental deletion of this object [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
    gatewayUrl string
    Akeyless Gateway URL (Configuration Management port). Relevant only when the jwks-uri is accessible only from the gateway.
    gwBoundIps string[]
    A CIDR whitelist with the GW IPs that the access is restricted to
    issuer string
    Issuer URL
    jwksJsonData string
    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. base64 encoded string
    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.
    jwtTtl number
    Jwt TTL
    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]
    audience str
    The audience in the JWT
    audit_logs_claims Sequence[str]
    Subclaims to include in audit logs, e.g "--audit-logs-claims email --audit-logs-claims username"
    auth_method_oauth2_id str
    The ID of this resource.
    bound_client_ids Sequence[str]
    The clients ids that the access is restricted to
    bound_ips Sequence[str]
    A CIDR whitelist with the IPs that the access is restricted to
    cert str
    CertificateFile Path to a file that contain the certificate in a PEM format.
    cert_file_data str
    CertificateFileData PEM Certificate in a Base64 format.
    delete_protection str
    Protection from accidental deletion of this object [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
    gateway_url str
    Akeyless Gateway URL (Configuration Management port). Relevant only when the jwks-uri is accessible only from the gateway.
    gw_bound_ips Sequence[str]
    A CIDR whitelist with the GW IPs that the access is restricted to
    issuer str
    Issuer URL
    jwks_json_data str
    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. base64 encoded string
    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.
    jwt_ttl float
    Jwt TTL
    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]
    audience String
    The audience in the JWT
    auditLogsClaims List<String>
    Subclaims to include in audit logs, e.g "--audit-logs-claims email --audit-logs-claims username"
    authMethodOauth2Id String
    The ID of this resource.
    boundClientIds List<String>
    The clients ids that the access is restricted to
    boundIps List<String>
    A CIDR whitelist with the IPs that the access is restricted to
    cert String
    CertificateFile Path to a file that contain the certificate in a PEM format.
    certFileData String
    CertificateFileData PEM Certificate in a Base64 format.
    deleteProtection String
    Protection from accidental deletion of this object [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
    gatewayUrl String
    Akeyless Gateway URL (Configuration Management port). Relevant only when the jwks-uri is accessible only from the gateway.
    gwBoundIps List<String>
    A CIDR whitelist with the GW IPs that the access is restricted to
    issuer String
    Issuer URL
    jwksJsonData String
    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. base64 encoded string
    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.
    jwtTtl Number
    Jwt TTL
    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 AuthMethodOauth2 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.
    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 AuthMethodOauth2 Resource

    Get an existing AuthMethodOauth2 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?: AuthMethodOauth2State, opts?: CustomResourceOptions): AuthMethodOauth2
    @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,
        audience: Optional[str] = None,
        audit_logs_claims: Optional[Sequence[str]] = None,
        auth_method_oauth2_id: Optional[str] = None,
        bound_client_ids: Optional[Sequence[str]] = None,
        bound_ips: Optional[Sequence[str]] = None,
        cert: Optional[str] = None,
        cert_file_data: Optional[str] = None,
        delete_protection: Optional[str] = None,
        description: Optional[str] = None,
        expiration_event_ins: Optional[Sequence[str]] = None,
        force_sub_claims: Optional[bool] = None,
        gateway_url: Optional[str] = None,
        gw_bound_ips: Optional[Sequence[str]] = None,
        issuer: Optional[str] = None,
        jwks_json_data: Optional[str] = None,
        jwks_uri: 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) -> AuthMethodOauth2
    func GetAuthMethodOauth2(ctx *Context, name string, id IDInput, state *AuthMethodOauth2State, opts ...ResourceOption) (*AuthMethodOauth2, error)
    public static AuthMethodOauth2 Get(string name, Input<string> id, AuthMethodOauth2State? state, CustomResourceOptions? opts = null)
    public static AuthMethodOauth2 get(String name, Output<String> id, AuthMethodOauth2State state, CustomResourceOptions options)
    resources:  _:    type: akeyless:AuthMethodOauth2    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
    AllowedClientTypes List<string>
    Limit the auth method usage for specific client types [cli,ui,gateway-admin,sdk,mobile,extension]
    Audience string
    The audience in the JWT
    AuditLogsClaims List<string>
    Subclaims to include in audit logs, e.g "--audit-logs-claims email --audit-logs-claims username"
    AuthMethodOauth2Id string
    The ID of this resource.
    BoundClientIds List<string>
    The clients ids that the access is restricted to
    BoundIps List<string>
    A CIDR whitelist with the IPs that the access is restricted to
    Cert string
    CertificateFile Path to a file that contain the certificate in a PEM format.
    CertFileData string
    CertificateFileData PEM Certificate in a Base64 format.
    DeleteProtection string
    Protection from accidental deletion of this object [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
    GatewayUrl string
    Akeyless Gateway URL (Configuration Management port). Relevant only when the jwks-uri is accessible only from the gateway.
    GwBoundIps List<string>
    A CIDR whitelist with the GW IPs that the access is restricted to
    Issuer string
    Issuer URL
    JwksJsonData string
    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. base64 encoded string
    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.
    JwtTtl double
    Jwt TTL
    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]
    Audience string
    The audience in the JWT
    AuditLogsClaims []string
    Subclaims to include in audit logs, e.g "--audit-logs-claims email --audit-logs-claims username"
    AuthMethodOauth2Id string
    The ID of this resource.
    BoundClientIds []string
    The clients ids that the access is restricted to
    BoundIps []string
    A CIDR whitelist with the IPs that the access is restricted to
    Cert string
    CertificateFile Path to a file that contain the certificate in a PEM format.
    CertFileData string
    CertificateFileData PEM Certificate in a Base64 format.
    DeleteProtection string
    Protection from accidental deletion of this object [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
    GatewayUrl string
    Akeyless Gateway URL (Configuration Management port). Relevant only when the jwks-uri is accessible only from the gateway.
    GwBoundIps []string
    A CIDR whitelist with the GW IPs that the access is restricted to
    Issuer string
    Issuer URL
    JwksJsonData string
    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. base64 encoded string
    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.
    JwtTtl float64
    Jwt TTL
    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.
    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]
    audience String
    The audience in the JWT
    auditLogsClaims List<String>
    Subclaims to include in audit logs, e.g "--audit-logs-claims email --audit-logs-claims username"
    authMethodOauth2Id String
    The ID of this resource.
    boundClientIds List<String>
    The clients ids that the access is restricted to
    boundIps List<String>
    A CIDR whitelist with the IPs that the access is restricted to
    cert String
    CertificateFile Path to a file that contain the certificate in a PEM format.
    certFileData String
    CertificateFileData PEM Certificate in a Base64 format.
    deleteProtection String
    Protection from accidental deletion of this object [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
    gatewayUrl String
    Akeyless Gateway URL (Configuration Management port). Relevant only when the jwks-uri is accessible only from the gateway.
    gwBoundIps List<String>
    A CIDR whitelist with the GW IPs that the access is restricted to
    issuer String
    Issuer URL
    jwksJsonData String
    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. base64 encoded string
    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.
    jwtTtl Double
    Jwt TTL
    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]
    audience string
    The audience in the JWT
    auditLogsClaims string[]
    Subclaims to include in audit logs, e.g "--audit-logs-claims email --audit-logs-claims username"
    authMethodOauth2Id string
    The ID of this resource.
    boundClientIds string[]
    The clients ids that the access is restricted to
    boundIps string[]
    A CIDR whitelist with the IPs that the access is restricted to
    cert string
    CertificateFile Path to a file that contain the certificate in a PEM format.
    certFileData string
    CertificateFileData PEM Certificate in a Base64 format.
    deleteProtection string
    Protection from accidental deletion of this object [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
    gatewayUrl string
    Akeyless Gateway URL (Configuration Management port). Relevant only when the jwks-uri is accessible only from the gateway.
    gwBoundIps string[]
    A CIDR whitelist with the GW IPs that the access is restricted to
    issuer string
    Issuer URL
    jwksJsonData string
    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. base64 encoded string
    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.
    jwtTtl number
    Jwt TTL
    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]
    audience str
    The audience in the JWT
    audit_logs_claims Sequence[str]
    Subclaims to include in audit logs, e.g "--audit-logs-claims email --audit-logs-claims username"
    auth_method_oauth2_id str
    The ID of this resource.
    bound_client_ids Sequence[str]
    The clients ids that the access is restricted to
    bound_ips Sequence[str]
    A CIDR whitelist with the IPs that the access is restricted to
    cert str
    CertificateFile Path to a file that contain the certificate in a PEM format.
    cert_file_data str
    CertificateFileData PEM Certificate in a Base64 format.
    delete_protection str
    Protection from accidental deletion of this object [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
    gateway_url str
    Akeyless Gateway URL (Configuration Management port). Relevant only when the jwks-uri is accessible only from the gateway.
    gw_bound_ips Sequence[str]
    A CIDR whitelist with the GW IPs that the access is restricted to
    issuer str
    Issuer URL
    jwks_json_data str
    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. base64 encoded string
    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.
    jwt_ttl float
    Jwt TTL
    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]
    audience String
    The audience in the JWT
    auditLogsClaims List<String>
    Subclaims to include in audit logs, e.g "--audit-logs-claims email --audit-logs-claims username"
    authMethodOauth2Id String
    The ID of this resource.
    boundClientIds List<String>
    The clients ids that the access is restricted to
    boundIps List<String>
    A CIDR whitelist with the IPs that the access is restricted to
    cert String
    CertificateFile Path to a file that contain the certificate in a PEM format.
    certFileData String
    CertificateFileData PEM Certificate in a Base64 format.
    deleteProtection String
    Protection from accidental deletion of this object [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
    gatewayUrl String
    Akeyless Gateway URL (Configuration Management port). Relevant only when the jwks-uri is accessible only from the gateway.
    gwBoundIps List<String>
    A CIDR whitelist with the GW IPs that the access is restricted to
    issuer String
    Issuer URL
    jwksJsonData String
    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. base64 encoded string
    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.
    jwtTtl Number
    Jwt TTL
    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.

    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.