published on Thursday, Nov 19, 2026 by akeyless-community
published on Thursday, Nov 19, 2026 by akeyless-community
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,
force_sub_claims: Optional[bool] = None,
delete_protection: 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,
gateway_url: Optional[str] = None,
access_expires: Optional[float] = None,
description: Optional[str] = None,
audience: Optional[str] = None,
expiration_event_ins: Optional[Sequence[str]] = None,
cert_file_data: 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,
retry: Optional[AuthMethodOauth2RetryArgs] = 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.
resource "akeyless_auth_method_oauth2" "name" {
# resource properties
}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",
ForceSubClaims = false,
DeleteProtection = "string",
AuditLogsClaims = new[]
{
"string",
},
AuthMethodOauth2Id = "string",
BoundClientIds = new[]
{
"string",
},
BoundIps = new[]
{
"string",
},
Cert = "string",
GatewayUrl = "string",
AccessExpires = 0.0,
Description = "string",
Audience = "string",
ExpirationEventIns = new[]
{
"string",
},
CertFileData = "string",
GwBoundIps = new[]
{
"string",
},
Issuer = "string",
JwksJsonData = "string",
JwksUri = "string",
JwtTtl = 0.0,
Name = "string",
ProductTypes = new[]
{
"string",
},
Retry = new Akeyless.Inputs.AuthMethodOauth2RetryArgs
{
ErrorMessageRegexes = new[]
{
"string",
},
IntervalSeconds = 0.0,
MaxIntervalSeconds = 0.0,
MaxRetries = 0.0,
RetryOnStatusCodes = new[]
{
0.0,
},
},
SubclaimsDelimiters = new[]
{
"string",
},
AllowedClientTypes = new[]
{
"string",
},
});
example, err := akeyless.NewAuthMethodOauth2(ctx, "authMethodOauth2Resource", &akeyless.AuthMethodOauth2Args{
UniqueIdentifier: pulumi.String("string"),
ForceSubClaims: pulumi.Bool(false),
DeleteProtection: pulumi.String("string"),
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"),
GatewayUrl: pulumi.String("string"),
AccessExpires: pulumi.Float64(0),
Description: pulumi.String("string"),
Audience: pulumi.String("string"),
ExpirationEventIns: pulumi.StringArray{
pulumi.String("string"),
},
CertFileData: pulumi.String("string"),
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"),
},
Retry: &akeyless.AuthMethodOauth2RetryArgs{
ErrorMessageRegexes: pulumi.StringArray{
pulumi.String("string"),
},
IntervalSeconds: pulumi.Float64(0),
MaxIntervalSeconds: pulumi.Float64(0),
MaxRetries: pulumi.Float64(0),
RetryOnStatusCodes: pulumi.Float64Array{
pulumi.Float64(0),
},
},
SubclaimsDelimiters: pulumi.StringArray{
pulumi.String("string"),
},
AllowedClientTypes: pulumi.StringArray{
pulumi.String("string"),
},
})
resource "akeyless_auth_method_oauth2" "authMethodOauth2Resource" {
lifecycle {
create_before_destroy = true
}
unique_identifier = "string"
force_sub_claims = false
delete_protection = "string"
audit_logs_claims = ["string"]
auth_method_oauth2_id = "string"
bound_client_ids = ["string"]
bound_ips = ["string"]
cert = "string"
gateway_url = "string"
access_expires = 0
description = "string"
audience = "string"
expiration_event_ins = ["string"]
cert_file_data = "string"
gw_bound_ips = ["string"]
issuer = "string"
jwks_json_data = "string"
jwks_uri = "string"
jwt_ttl = 0
name = "string"
product_types = ["string"]
retry = {
error_message_regexes = ["string"]
interval_seconds = 0
max_interval_seconds = 0
max_retries = 0
retry_on_status_codes = [0]
}
subclaims_delimiters = ["string"]
allowed_client_types = ["string"]
}
var authMethodOauth2Resource = new AuthMethodOauth2("authMethodOauth2Resource", AuthMethodOauth2Args.builder()
.uniqueIdentifier("string")
.forceSubClaims(false)
.deleteProtection("string")
.auditLogsClaims("string")
.authMethodOauth2Id("string")
.boundClientIds("string")
.boundIps("string")
.cert("string")
.gatewayUrl("string")
.accessExpires(0.0)
.description("string")
.audience("string")
.expirationEventIns("string")
.certFileData("string")
.gwBoundIps("string")
.issuer("string")
.jwksJsonData("string")
.jwksUri("string")
.jwtTtl(0.0)
.name("string")
.productTypes("string")
.retry(AuthMethodOauth2RetryArgs.builder()
.errorMessageRegexes("string")
.intervalSeconds(0.0)
.maxIntervalSeconds(0.0)
.maxRetries(0.0)
.retryOnStatusCodes(0.0)
.build())
.subclaimsDelimiters("string")
.allowedClientTypes("string")
.build());
auth_method_oauth2_resource = akeyless.AuthMethodOauth2("authMethodOauth2Resource",
unique_identifier="string",
force_sub_claims=False,
delete_protection="string",
audit_logs_claims=["string"],
auth_method_oauth2_id="string",
bound_client_ids=["string"],
bound_ips=["string"],
cert="string",
gateway_url="string",
access_expires=float(0),
description="string",
audience="string",
expiration_event_ins=["string"],
cert_file_data="string",
gw_bound_ips=["string"],
issuer="string",
jwks_json_data="string",
jwks_uri="string",
jwt_ttl=float(0),
name="string",
product_types=["string"],
retry={
"error_message_regexes": ["string"],
"interval_seconds": float(0),
"max_interval_seconds": float(0),
"max_retries": float(0),
"retry_on_status_codes": [float(0)],
},
subclaims_delimiters=["string"],
allowed_client_types=["string"])
const authMethodOauth2Resource = new akeyless.AuthMethodOauth2("authMethodOauth2Resource", {
uniqueIdentifier: "string",
forceSubClaims: false,
deleteProtection: "string",
auditLogsClaims: ["string"],
authMethodOauth2Id: "string",
boundClientIds: ["string"],
boundIps: ["string"],
cert: "string",
gatewayUrl: "string",
accessExpires: 0,
description: "string",
audience: "string",
expirationEventIns: ["string"],
certFileData: "string",
gwBoundIps: ["string"],
issuer: "string",
jwksJsonData: "string",
jwksUri: "string",
jwtTtl: 0,
name: "string",
productTypes: ["string"],
retry: {
errorMessageRegexes: ["string"],
intervalSeconds: 0,
maxIntervalSeconds: 0,
maxRetries: 0,
retryOnStatusCodes: [0],
},
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
retry:
errorMessageRegexes:
- string
intervalSeconds: 0
maxIntervalSeconds: 0
maxRetries: 0
retryOnStatusCodes:
- 0
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:
- 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 double - Access expiration date in Unix timestamp (select 0 for access without expiry date)
- Allowed
Client List<string>Types - Limit the auth method usage for specific client types [cli,ui,gateway-admin,sdk,mobile,extension]
- Audience string
- The audience in the JWT
- Audit
Logs List<string>Claims - Subclaims to include in audit logs, e.g "--audit-logs-claims email --audit-logs-claims username"
- Auth
Method stringOauth2Id - The ID of this resource.
- Bound
Client List<string>Ids - The clients ids that the access is restricted to
- Bound
Ips 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.
- Cert
File stringData - CertificateFileData PEM Certificate in a Base64 format.
- Delete
Protection string - Protection from accidental deletion of this object [true/false]
- Description string
- Auth Method description
- Expiration
Event List<string>Ins - How many days before the expiration of the auth method would you like to be notified
- Force
Sub boolClaims - if true: enforce role-association must include sub claims
- Gateway
Url string - Akeyless Gateway URL (Configuration Management port). Relevant only when the jwks-uri is accessible only from the gateway.
- Gw
Bound List<string>Ips - A CIDR whitelist with the GW IPs that the access is restricted to
- Issuer string
- Issuer URL
- Jwks
Json stringData - 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 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.
- Jwt
Ttl double - Jwt TTL
- Name string
- Auth Method name
- Product
Types List<string> - Choose the relevant product type for the auth method [sm, sra, pm, dp, ca]
- Retry
Auth
Method Oauth2Retry - Retry this resource's operations when the error matches errormessageregex or the HTTP status is in retryonstatus_codes. Overrides the provider retry block. See the Customized Retry guide.
- 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.
- Access
Expires float64 - Access expiration date in Unix timestamp (select 0 for access without expiry date)
- Allowed
Client []stringTypes - Limit the auth method usage for specific client types [cli,ui,gateway-admin,sdk,mobile,extension]
- Audience string
- The audience in the JWT
- Audit
Logs []stringClaims - Subclaims to include in audit logs, e.g "--audit-logs-claims email --audit-logs-claims username"
- Auth
Method stringOauth2Id - The ID of this resource.
- Bound
Client []stringIds - The clients ids that the access is restricted to
- Bound
Ips []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.
- Cert
File stringData - CertificateFileData PEM Certificate in a Base64 format.
- Delete
Protection string - Protection from accidental deletion of this object [true/false]
- Description string
- Auth Method description
- Expiration
Event []stringIns - How many days before the expiration of the auth method would you like to be notified
- Force
Sub boolClaims - if true: enforce role-association must include sub claims
- Gateway
Url string - Akeyless Gateway URL (Configuration Management port). Relevant only when the jwks-uri is accessible only from the gateway.
- Gw
Bound []stringIps - A CIDR whitelist with the GW IPs that the access is restricted to
- Issuer string
- Issuer URL
- Jwks
Json stringData - 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 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.
- Jwt
Ttl float64 - Jwt TTL
- Name string
- Auth Method name
- Product
Types []string - Choose the relevant product type for the auth method [sm, sra, pm, dp, ca]
- Retry
Auth
Method Oauth2Retry Args - Retry this resource's operations when the error matches errormessageregex or the HTTP status is in retryonstatus_codes. Overrides the provider retry block. See the Customized Retry guide.
- Subclaims
Delimiters []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_ list(string)types - Limit the auth method usage for specific client types [cli,ui,gateway-admin,sdk,mobile,extension]
- audience string
- The audience in the JWT
- audit_
logs_ list(string)claims - Subclaims to include in audit logs, e.g "--audit-logs-claims email --audit-logs-claims username"
- auth_
method_ stringoauth2_ id - The ID of this resource.
- bound_
client_ list(string)ids - The clients ids that the access is restricted to
- bound_
ips 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.
- cert_
file_ stringdata - CertificateFileData PEM Certificate in a Base64 format.
- delete_
protection string - Protection from accidental deletion of this object [true/false]
- description string
- Auth Method description
- expiration_
event_ list(string)ins - How many days before the expiration of the auth method would you like to be notified
- force_
sub_ boolclaims - if true: enforce role-association must include sub claims
- gateway_
url string - Akeyless Gateway URL (Configuration Management port). Relevant only when the jwks-uri is accessible only from the gateway.
- gw_
bound_ list(string)ips - A CIDR whitelist with the GW IPs that the access is restricted to
- issuer string
- Issuer URL
- jwks_
json_ stringdata - 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 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.
- jwt_
ttl number - Jwt TTL
- name string
- Auth Method name
- product_
types list(string) - Choose the relevant product type for the auth method [sm, sra, pm, dp, ca]
- retry object
- Retry this resource's operations when the error matches errormessageregex or the HTTP status is in retryonstatus_codes. Overrides the provider retry block. See the Customized Retry guide.
- 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.
- access
Expires Double - Access expiration date in Unix timestamp (select 0 for access without expiry date)
- allowed
Client List<String>Types - Limit the auth method usage for specific client types [cli,ui,gateway-admin,sdk,mobile,extension]
- audience String
- The audience in the JWT
- audit
Logs List<String>Claims - Subclaims to include in audit logs, e.g "--audit-logs-claims email --audit-logs-claims username"
- auth
Method StringOauth2Id - The ID of this resource.
- bound
Client List<String>Ids - The clients ids that the access is restricted to
- bound
Ips 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.
- cert
File StringData - CertificateFileData PEM Certificate in a Base64 format.
- delete
Protection String - Protection from accidental deletion of this object [true/false]
- description String
- Auth Method description
- expiration
Event List<String>Ins - How many days before the expiration of the auth method would you like to be notified
- force
Sub BooleanClaims - if true: enforce role-association must include sub claims
- gateway
Url String - Akeyless Gateway URL (Configuration Management port). Relevant only when the jwks-uri is accessible only from the gateway.
- gw
Bound List<String>Ips - A CIDR whitelist with the GW IPs that the access is restricted to
- issuer String
- Issuer URL
- jwks
Json StringData - 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 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.
- jwt
Ttl Double - Jwt TTL
- name String
- Auth Method name
- product
Types List<String> - Choose the relevant product type for the auth method [sm, sra, pm, dp, ca]
- retry
Auth
Method Oauth2Retry - Retry this resource's operations when the error matches errormessageregex or the HTTP status is in retryonstatus_codes. Overrides the provider retry block. See the Customized Retry guide.
- 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.
- access
Expires number - Access expiration date in Unix timestamp (select 0 for access without expiry date)
- allowed
Client string[]Types - Limit the auth method usage for specific client types [cli,ui,gateway-admin,sdk,mobile,extension]
- audience string
- The audience in the JWT
- audit
Logs string[]Claims - Subclaims to include in audit logs, e.g "--audit-logs-claims email --audit-logs-claims username"
- auth
Method stringOauth2Id - The ID of this resource.
- bound
Client string[]Ids - The clients ids that the access is restricted to
- bound
Ips 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.
- cert
File stringData - CertificateFileData PEM Certificate in a Base64 format.
- delete
Protection string - Protection from accidental deletion of this object [true/false]
- description string
- Auth Method description
- expiration
Event string[]Ins - How many days before the expiration of the auth method would you like to be notified
- force
Sub booleanClaims - if true: enforce role-association must include sub claims
- gateway
Url string - Akeyless Gateway URL (Configuration Management port). Relevant only when the jwks-uri is accessible only from the gateway.
- gw
Bound string[]Ips - A CIDR whitelist with the GW IPs that the access is restricted to
- issuer string
- Issuer URL
- jwks
Json stringData - 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 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.
- jwt
Ttl number - Jwt TTL
- name string
- Auth Method name
- product
Types string[] - Choose the relevant product type for the auth method [sm, sra, pm, dp, ca]
- retry
Auth
Method Oauth2Retry - Retry this resource's operations when the error matches errormessageregex or the HTTP status is in retryonstatus_codes. Overrides the provider retry block. See the Customized Retry guide.
- subclaims
Delimiters 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_ Sequence[str]types - 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_ Sequence[str]claims - Subclaims to include in audit logs, e.g "--audit-logs-claims email --audit-logs-claims username"
- auth_
method_ stroauth2_ id - The ID of this resource.
- bound_
client_ Sequence[str]ids - 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_ strdata - 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_ Sequence[str]ins - How many days before the expiration of the auth method would you like to be notified
- force_
sub_ boolclaims - 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_ Sequence[str]ips - A CIDR whitelist with the GW IPs that the access is restricted to
- issuer str
- Issuer URL
- jwks_
json_ strdata - 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]
- retry
Auth
Method Oauth2Retry Args - Retry this resource's operations when the error matches errormessageregex or the HTTP status is in retryonstatus_codes. Overrides the provider retry block. See the Customized Retry guide.
- subclaims_
delimiters Sequence[str] - 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 List<String>Types - Limit the auth method usage for specific client types [cli,ui,gateway-admin,sdk,mobile,extension]
- audience String
- The audience in the JWT
- audit
Logs List<String>Claims - Subclaims to include in audit logs, e.g "--audit-logs-claims email --audit-logs-claims username"
- auth
Method StringOauth2Id - The ID of this resource.
- bound
Client List<String>Ids - The clients ids that the access is restricted to
- bound
Ips 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.
- cert
File StringData - CertificateFileData PEM Certificate in a Base64 format.
- delete
Protection String - Protection from accidental deletion of this object [true/false]
- description String
- Auth Method description
- expiration
Event List<String>Ins - How many days before the expiration of the auth method would you like to be notified
- force
Sub BooleanClaims - if true: enforce role-association must include sub claims
- gateway
Url String - Akeyless Gateway URL (Configuration Management port). Relevant only when the jwks-uri is accessible only from the gateway.
- gw
Bound List<String>Ips - A CIDR whitelist with the GW IPs that the access is restricted to
- issuer String
- Issuer URL
- jwks
Json StringData - 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 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.
- jwt
Ttl Number - Jwt TTL
- name String
- Auth Method name
- product
Types List<String> - Choose the relevant product type for the auth method [sm, sra, pm, dp, ca]
- retry Property Map
- Retry this resource's operations when the error matches errormessageregex or the HTTP status is in retryonstatus_codes. Overrides the provider retry block. See the Customized Retry guide.
- subclaims
Delimiters 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:
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,
retry: Optional[AuthMethodOauth2RetryArgs] = None,
subclaims_delimiters: Optional[Sequence[str]] = None,
unique_identifier: Optional[str] = None) -> AuthMethodOauth2func 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: existingAuthMethodOauth2: type: akeyless:AuthMethodOauth2 get: id: ${id}import {
to = akeyless_auth_method_oauth2.example
id = "${id}"
}
- name string
- The unique name of the resulting resource.
- id Input<ID>
- The unique provider ID of the resource to look up.
- state AuthMethodOauth2State
- Known property values the provider needs, along with the ID, to find the resource. Usually not required.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resulting resource.
- id str
- The unique provider ID of the resource to look up.
- 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 resulting resource.
- id IDInput
- The unique provider ID of the resource to look up.
- state AuthMethodOauth2State
- Known property values the provider needs, along with the ID, to find the resource. Usually not required.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resulting resource.
- id Input<string>
- The unique provider ID of the resource to look up.
- state AuthMethodOauth2State
- Known property values the provider needs, along with the ID, to find the resource. Usually not required.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resulting resource.
- id Output<String>
- The unique provider ID of the resource to look up.
- state AuthMethodOauth2State
- Known property values the provider needs, along with the ID, to find the resource. Usually not required.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
- Access
Expires double - Access expiration date in Unix timestamp (select 0 for access without expiry date)
- Access
Id string - Auth Method access ID
- Allowed
Client List<string>Types - Limit the auth method usage for specific client types [cli,ui,gateway-admin,sdk,mobile,extension]
- Audience string
- The audience in the JWT
- Audit
Logs List<string>Claims - Subclaims to include in audit logs, e.g "--audit-logs-claims email --audit-logs-claims username"
- Auth
Method stringOauth2Id - The ID of this resource.
- Bound
Client List<string>Ids - The clients ids that the access is restricted to
- Bound
Ips 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.
- Cert
File stringData - CertificateFileData PEM Certificate in a Base64 format.
- Delete
Protection string - Protection from accidental deletion of this object [true/false]
- Description string
- Auth Method description
- Expiration
Event List<string>Ins - How many days before the expiration of the auth method would you like to be notified
- Force
Sub boolClaims - if true: enforce role-association must include sub claims
- Gateway
Url string - Akeyless Gateway URL (Configuration Management port). Relevant only when the jwks-uri is accessible only from the gateway.
- Gw
Bound List<string>Ips - A CIDR whitelist with the GW IPs that the access is restricted to
- Issuer string
- Issuer URL
- Jwks
Json stringData - 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 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.
- Jwt
Ttl double - Jwt TTL
- Name string
- Auth Method name
- Product
Types List<string> - Choose the relevant product type for the auth method [sm, sra, pm, dp, ca]
- Retry
Auth
Method Oauth2Retry - Retry this resource's operations when the error matches errormessageregex or the HTTP status is in retryonstatus_codes. Overrides the provider retry block. See the Customized Retry guide.
- 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.
- Access
Expires float64 - Access expiration date in Unix timestamp (select 0 for access without expiry date)
- Access
Id string - Auth Method access ID
- Allowed
Client []stringTypes - Limit the auth method usage for specific client types [cli,ui,gateway-admin,sdk,mobile,extension]
- Audience string
- The audience in the JWT
- Audit
Logs []stringClaims - Subclaims to include in audit logs, e.g "--audit-logs-claims email --audit-logs-claims username"
- Auth
Method stringOauth2Id - The ID of this resource.
- Bound
Client []stringIds - The clients ids that the access is restricted to
- Bound
Ips []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.
- Cert
File stringData - CertificateFileData PEM Certificate in a Base64 format.
- Delete
Protection string - Protection from accidental deletion of this object [true/false]
- Description string
- Auth Method description
- Expiration
Event []stringIns - How many days before the expiration of the auth method would you like to be notified
- Force
Sub boolClaims - if true: enforce role-association must include sub claims
- Gateway
Url string - Akeyless Gateway URL (Configuration Management port). Relevant only when the jwks-uri is accessible only from the gateway.
- Gw
Bound []stringIps - A CIDR whitelist with the GW IPs that the access is restricted to
- Issuer string
- Issuer URL
- Jwks
Json stringData - 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 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.
- Jwt
Ttl float64 - Jwt TTL
- Name string
- Auth Method name
- Product
Types []string - Choose the relevant product type for the auth method [sm, sra, pm, dp, ca]
- Retry
Auth
Method Oauth2Retry Args - Retry this resource's operations when the error matches errormessageregex or the HTTP status is in retryonstatus_codes. Overrides the provider retry block. See the Customized Retry guide.
- Subclaims
Delimiters []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)
- access_
id string - Auth Method access ID
- allowed_
client_ list(string)types - Limit the auth method usage for specific client types [cli,ui,gateway-admin,sdk,mobile,extension]
- audience string
- The audience in the JWT
- audit_
logs_ list(string)claims - Subclaims to include in audit logs, e.g "--audit-logs-claims email --audit-logs-claims username"
- auth_
method_ stringoauth2_ id - The ID of this resource.
- bound_
client_ list(string)ids - The clients ids that the access is restricted to
- bound_
ips 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.
- cert_
file_ stringdata - CertificateFileData PEM Certificate in a Base64 format.
- delete_
protection string - Protection from accidental deletion of this object [true/false]
- description string
- Auth Method description
- expiration_
event_ list(string)ins - How many days before the expiration of the auth method would you like to be notified
- force_
sub_ boolclaims - if true: enforce role-association must include sub claims
- gateway_
url string - Akeyless Gateway URL (Configuration Management port). Relevant only when the jwks-uri is accessible only from the gateway.
- gw_
bound_ list(string)ips - A CIDR whitelist with the GW IPs that the access is restricted to
- issuer string
- Issuer URL
- jwks_
json_ stringdata - 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 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.
- jwt_
ttl number - Jwt TTL
- name string
- Auth Method name
- product_
types list(string) - Choose the relevant product type for the auth method [sm, sra, pm, dp, ca]
- retry object
- Retry this resource's operations when the error matches errormessageregex or the HTTP status is in retryonstatus_codes. Overrides the provider retry block. See the Customized Retry guide.
- 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.
- access
Expires Double - Access expiration date in Unix timestamp (select 0 for access without expiry date)
- access
Id String - Auth Method access ID
- allowed
Client List<String>Types - Limit the auth method usage for specific client types [cli,ui,gateway-admin,sdk,mobile,extension]
- audience String
- The audience in the JWT
- audit
Logs List<String>Claims - Subclaims to include in audit logs, e.g "--audit-logs-claims email --audit-logs-claims username"
- auth
Method StringOauth2Id - The ID of this resource.
- bound
Client List<String>Ids - The clients ids that the access is restricted to
- bound
Ips 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.
- cert
File StringData - CertificateFileData PEM Certificate in a Base64 format.
- delete
Protection String - Protection from accidental deletion of this object [true/false]
- description String
- Auth Method description
- expiration
Event List<String>Ins - How many days before the expiration of the auth method would you like to be notified
- force
Sub BooleanClaims - if true: enforce role-association must include sub claims
- gateway
Url String - Akeyless Gateway URL (Configuration Management port). Relevant only when the jwks-uri is accessible only from the gateway.
- gw
Bound List<String>Ips - A CIDR whitelist with the GW IPs that the access is restricted to
- issuer String
- Issuer URL
- jwks
Json StringData - 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 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.
- jwt
Ttl Double - Jwt TTL
- name String
- Auth Method name
- product
Types List<String> - Choose the relevant product type for the auth method [sm, sra, pm, dp, ca]
- retry
Auth
Method Oauth2Retry - Retry this resource's operations when the error matches errormessageregex or the HTTP status is in retryonstatus_codes. Overrides the provider retry block. See the Customized Retry guide.
- 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.
- 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 string[]Types - Limit the auth method usage for specific client types [cli,ui,gateway-admin,sdk,mobile,extension]
- audience string
- The audience in the JWT
- audit
Logs string[]Claims - Subclaims to include in audit logs, e.g "--audit-logs-claims email --audit-logs-claims username"
- auth
Method stringOauth2Id - The ID of this resource.
- bound
Client string[]Ids - The clients ids that the access is restricted to
- bound
Ips 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.
- cert
File stringData - CertificateFileData PEM Certificate in a Base64 format.
- delete
Protection string - Protection from accidental deletion of this object [true/false]
- description string
- Auth Method description
- expiration
Event string[]Ins - How many days before the expiration of the auth method would you like to be notified
- force
Sub booleanClaims - if true: enforce role-association must include sub claims
- gateway
Url string - Akeyless Gateway URL (Configuration Management port). Relevant only when the jwks-uri is accessible only from the gateway.
- gw
Bound string[]Ips - A CIDR whitelist with the GW IPs that the access is restricted to
- issuer string
- Issuer URL
- jwks
Json stringData - 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 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.
- jwt
Ttl number - Jwt TTL
- name string
- Auth Method name
- product
Types string[] - Choose the relevant product type for the auth method [sm, sra, pm, dp, ca]
- retry
Auth
Method Oauth2Retry - Retry this resource's operations when the error matches errormessageregex or the HTTP status is in retryonstatus_codes. Overrides the provider retry block. See the Customized Retry guide.
- subclaims
Delimiters 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 float - Access expiration date in Unix timestamp (select 0 for access without expiry date)
- access_
id str - Auth Method access ID
- allowed_
client_ Sequence[str]types - 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_ Sequence[str]claims - Subclaims to include in audit logs, e.g "--audit-logs-claims email --audit-logs-claims username"
- auth_
method_ stroauth2_ id - The ID of this resource.
- bound_
client_ Sequence[str]ids - 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_ strdata - 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_ Sequence[str]ins - How many days before the expiration of the auth method would you like to be notified
- force_
sub_ boolclaims - 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_ Sequence[str]ips - A CIDR whitelist with the GW IPs that the access is restricted to
- issuer str
- Issuer URL
- jwks_
json_ strdata - 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]
- retry
Auth
Method Oauth2Retry Args - Retry this resource's operations when the error matches errormessageregex or the HTTP status is in retryonstatus_codes. Overrides the provider retry block. See the Customized Retry guide.
- 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.
- 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 List<String>Types - Limit the auth method usage for specific client types [cli,ui,gateway-admin,sdk,mobile,extension]
- audience String
- The audience in the JWT
- audit
Logs List<String>Claims - Subclaims to include in audit logs, e.g "--audit-logs-claims email --audit-logs-claims username"
- auth
Method StringOauth2Id - The ID of this resource.
- bound
Client List<String>Ids - The clients ids that the access is restricted to
- bound
Ips 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.
- cert
File StringData - CertificateFileData PEM Certificate in a Base64 format.
- delete
Protection String - Protection from accidental deletion of this object [true/false]
- description String
- Auth Method description
- expiration
Event List<String>Ins - How many days before the expiration of the auth method would you like to be notified
- force
Sub BooleanClaims - if true: enforce role-association must include sub claims
- gateway
Url String - Akeyless Gateway URL (Configuration Management port). Relevant only when the jwks-uri is accessible only from the gateway.
- gw
Bound List<String>Ips - A CIDR whitelist with the GW IPs that the access is restricted to
- issuer String
- Issuer URL
- jwks
Json StringData - 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 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.
- jwt
Ttl Number - Jwt TTL
- name String
- Auth Method name
- product
Types List<String> - Choose the relevant product type for the auth method [sm, sra, pm, dp, ca]
- retry Property Map
- Retry this resource's operations when the error matches errormessageregex or the HTTP status is in retryonstatus_codes. Overrides the provider retry block. See the Customized Retry guide.
- 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.
Supporting Types
AuthMethodOauth2Retry, AuthMethodOauth2RetryArgs
- Error
Message List<string>Regexes - Regular expressions matched against the error message. If any matches, the operation is retried.
- Interval
Seconds double - Wait before the first retry, in seconds. The wait doubles on each retry.
- Max
Interval doubleSeconds - Maximum wait between retries, in seconds.
- Max
Retries double - Maximum number of retries after the first attempt.
- Retry
On List<double>Status Codes - HTTP status codes of the failed API call that trigger a retry, for example 429 or 503.
- Error
Message []stringRegexes - Regular expressions matched against the error message. If any matches, the operation is retried.
- Interval
Seconds float64 - Wait before the first retry, in seconds. The wait doubles on each retry.
- Max
Interval float64Seconds - Maximum wait between retries, in seconds.
- Max
Retries float64 - Maximum number of retries after the first attempt.
- Retry
On []float64Status Codes - HTTP status codes of the failed API call that trigger a retry, for example 429 or 503.
- error_
message_ list(string)regexes - Regular expressions matched against the error message. If any matches, the operation is retried.
- interval_
seconds number - Wait before the first retry, in seconds. The wait doubles on each retry.
- max_
interval_ numberseconds - Maximum wait between retries, in seconds.
- max_
retries number - Maximum number of retries after the first attempt.
- retry_
on_ list(number)status_ codes - HTTP status codes of the failed API call that trigger a retry, for example 429 or 503.
- error
Message List<String>Regexes - Regular expressions matched against the error message. If any matches, the operation is retried.
- interval
Seconds Double - Wait before the first retry, in seconds. The wait doubles on each retry.
- max
Interval DoubleSeconds - Maximum wait between retries, in seconds.
- max
Retries Double - Maximum number of retries after the first attempt.
- retry
On List<Double>Status Codes - HTTP status codes of the failed API call that trigger a retry, for example 429 or 503.
- error
Message string[]Regexes - Regular expressions matched against the error message. If any matches, the operation is retried.
- interval
Seconds number - Wait before the first retry, in seconds. The wait doubles on each retry.
- max
Interval numberSeconds - Maximum wait between retries, in seconds.
- max
Retries number - Maximum number of retries after the first attempt.
- retry
On number[]Status Codes - HTTP status codes of the failed API call that trigger a retry, for example 429 or 503.
- error_
message_ Sequence[str]regexes - Regular expressions matched against the error message. If any matches, the operation is retried.
- interval_
seconds float - Wait before the first retry, in seconds. The wait doubles on each retry.
- max_
interval_ floatseconds - Maximum wait between retries, in seconds.
- max_
retries float - Maximum number of retries after the first attempt.
- retry_
on_ Sequence[float]status_ codes - HTTP status codes of the failed API call that trigger a retry, for example 429 or 503.
- error
Message List<String>Regexes - Regular expressions matched against the error message. If any matches, the operation is retried.
- interval
Seconds Number - Wait before the first retry, in seconds. The wait doubles on each retry.
- max
Interval NumberSeconds - Maximum wait between retries, in seconds.
- max
Retries Number - Maximum number of retries after the first attempt.
- retry
On List<Number>Status Codes - HTTP status codes of the failed API call that trigger a retry, for example 429 or 503.
Package Details
- Repository
- akeyless akeyless-community/terraform-provider-akeyless
- License
- Notes
- This Pulumi package is based on the
akeylessTerraform Provider.
published on Thursday, Nov 19, 2026 by akeyless-community