published on Monday, Apr 27, 2026 by akeyless-community
published on Monday, Apr 27, 2026 by akeyless-community
Oracle Cloud Infrastructure (OCI) Auth Method Resource
Create AuthMethodOci Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new AuthMethodOci(name: string, args: AuthMethodOciArgs, opts?: CustomResourceOptions);@overload
def AuthMethodOci(resource_name: str,
args: AuthMethodOciArgs,
opts: Optional[ResourceOptions] = None)
@overload
def AuthMethodOci(resource_name: str,
opts: Optional[ResourceOptions] = None,
group_ocids: Optional[Sequence[str]] = None,
tenant_ocid: Optional[str] = None,
auth_method_oci_id: Optional[str] = None,
access_expires: Optional[float] = None,
bound_ips: Optional[Sequence[str]] = None,
delete_protection: Optional[str] = None,
description: Optional[str] = None,
expiration_event_ins: Optional[Sequence[str]] = None,
force_sub_claims: Optional[bool] = None,
audit_logs_claims: Optional[Sequence[str]] = None,
gw_bound_ips: Optional[Sequence[str]] = None,
jwt_ttl: Optional[float] = None,
name: Optional[str] = None,
product_types: Optional[Sequence[str]] = None,
allowed_client_types: Optional[Sequence[str]] = None)func NewAuthMethodOci(ctx *Context, name string, args AuthMethodOciArgs, opts ...ResourceOption) (*AuthMethodOci, error)public AuthMethodOci(string name, AuthMethodOciArgs args, CustomResourceOptions? opts = null)
public AuthMethodOci(String name, AuthMethodOciArgs args)
public AuthMethodOci(String name, AuthMethodOciArgs args, CustomResourceOptions options)
type: akeyless:AuthMethodOci
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 AuthMethodOciArgs
- 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 AuthMethodOciArgs
- 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 AuthMethodOciArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args AuthMethodOciArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args AuthMethodOciArgs
- 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 authMethodOciResource = new Akeyless.AuthMethodOci("authMethodOciResource", new()
{
GroupOcids = new[]
{
"string",
},
TenantOcid = "string",
AuthMethodOciId = "string",
AccessExpires = 0,
BoundIps = new[]
{
"string",
},
DeleteProtection = "string",
Description = "string",
ExpirationEventIns = new[]
{
"string",
},
ForceSubClaims = false,
AuditLogsClaims = new[]
{
"string",
},
GwBoundIps = new[]
{
"string",
},
JwtTtl = 0,
Name = "string",
ProductTypes = new[]
{
"string",
},
AllowedClientTypes = new[]
{
"string",
},
});
example, err := akeyless.NewAuthMethodOci(ctx, "authMethodOciResource", &akeyless.AuthMethodOciArgs{
GroupOcids: pulumi.StringArray{
pulumi.String("string"),
},
TenantOcid: pulumi.String("string"),
AuthMethodOciId: pulumi.String("string"),
AccessExpires: pulumi.Float64(0),
BoundIps: pulumi.StringArray{
pulumi.String("string"),
},
DeleteProtection: pulumi.String("string"),
Description: pulumi.String("string"),
ExpirationEventIns: pulumi.StringArray{
pulumi.String("string"),
},
ForceSubClaims: pulumi.Bool(false),
AuditLogsClaims: pulumi.StringArray{
pulumi.String("string"),
},
GwBoundIps: pulumi.StringArray{
pulumi.String("string"),
},
JwtTtl: pulumi.Float64(0),
Name: pulumi.String("string"),
ProductTypes: pulumi.StringArray{
pulumi.String("string"),
},
AllowedClientTypes: pulumi.StringArray{
pulumi.String("string"),
},
})
var authMethodOciResource = new AuthMethodOci("authMethodOciResource", AuthMethodOciArgs.builder()
.groupOcids("string")
.tenantOcid("string")
.authMethodOciId("string")
.accessExpires(0.0)
.boundIps("string")
.deleteProtection("string")
.description("string")
.expirationEventIns("string")
.forceSubClaims(false)
.auditLogsClaims("string")
.gwBoundIps("string")
.jwtTtl(0.0)
.name("string")
.productTypes("string")
.allowedClientTypes("string")
.build());
auth_method_oci_resource = akeyless.AuthMethodOci("authMethodOciResource",
group_ocids=["string"],
tenant_ocid="string",
auth_method_oci_id="string",
access_expires=float(0),
bound_ips=["string"],
delete_protection="string",
description="string",
expiration_event_ins=["string"],
force_sub_claims=False,
audit_logs_claims=["string"],
gw_bound_ips=["string"],
jwt_ttl=float(0),
name="string",
product_types=["string"],
allowed_client_types=["string"])
const authMethodOciResource = new akeyless.AuthMethodOci("authMethodOciResource", {
groupOcids: ["string"],
tenantOcid: "string",
authMethodOciId: "string",
accessExpires: 0,
boundIps: ["string"],
deleteProtection: "string",
description: "string",
expirationEventIns: ["string"],
forceSubClaims: false,
auditLogsClaims: ["string"],
gwBoundIps: ["string"],
jwtTtl: 0,
name: "string",
productTypes: ["string"],
allowedClientTypes: ["string"],
});
type: akeyless:AuthMethodOci
properties:
accessExpires: 0
allowedClientTypes:
- string
auditLogsClaims:
- string
authMethodOciId: string
boundIps:
- string
deleteProtection: string
description: string
expirationEventIns:
- string
forceSubClaims: false
groupOcids:
- string
gwBoundIps:
- string
jwtTtl: 0
name: string
productTypes:
- string
tenantOcid: string
AuthMethodOci 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 AuthMethodOci resource accepts the following input properties:
- Group
Ocids List<string> - A list of required groups ocids
- Tenant
Ocid string - The Oracle Cloud tenant ID
- 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]
- Audit
Logs List<string>Claims - Subclaims to include in audit logs, e.g "--audit-logs-claims email --audit-logs-claims username"
- Auth
Method stringOci Id - The ID of this resource.
- Bound
Ips List<string> - A CIDR whitelist with the IPs that the access is restricted to
- Delete
Protection string - Protection from accidental deletion of this auth method, [true/false]
- Description string
- Auth Method description
- Expiration
Event 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
- Gw
Bound List<string>Ips - A CIDR whitelist with the GW IPs that the access is restricted to
- 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]
- Group
Ocids []string - A list of required groups ocids
- Tenant
Ocid string - The Oracle Cloud tenant ID
- 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]
- Audit
Logs []stringClaims - Subclaims to include in audit logs, e.g "--audit-logs-claims email --audit-logs-claims username"
- Auth
Method stringOci Id - The ID of this resource.
- Bound
Ips []string - A CIDR whitelist with the IPs that the access is restricted to
- Delete
Protection string - Protection from accidental deletion of this auth method, [true/false]
- Description string
- Auth Method description
- Expiration
Event []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
- Gw
Bound []stringIps - A CIDR whitelist with the GW IPs that the access is restricted to
- 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]
- group
Ocids List<String> - A list of required groups ocids
- tenant
Ocid String - The Oracle Cloud tenant ID
- 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]
- audit
Logs List<String>Claims - Subclaims to include in audit logs, e.g "--audit-logs-claims email --audit-logs-claims username"
- auth
Method StringOci Id - The ID of this resource.
- bound
Ips List<String> - A CIDR whitelist with the IPs that the access is restricted to
- delete
Protection String - Protection from accidental deletion of this auth method, [true/false]
- description String
- Auth Method description
- expiration
Event 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
- gw
Bound List<String>Ips - A CIDR whitelist with the GW IPs that the access is restricted to
- 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]
- group
Ocids string[] - A list of required groups ocids
- tenant
Ocid string - The Oracle Cloud tenant ID
- 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]
- audit
Logs string[]Claims - Subclaims to include in audit logs, e.g "--audit-logs-claims email --audit-logs-claims username"
- auth
Method stringOci Id - The ID of this resource.
- bound
Ips string[] - A CIDR whitelist with the IPs that the access is restricted to
- delete
Protection string - Protection from accidental deletion of this auth method, [true/false]
- description string
- Auth Method description
- expiration
Event 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
- gw
Bound string[]Ips - A CIDR whitelist with the GW IPs that the access is restricted to
- 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]
- group_
ocids Sequence[str] - A list of required groups ocids
- tenant_
ocid str - The Oracle Cloud tenant ID
- 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]
- audit_
logs_ Sequence[str]claims - Subclaims to include in audit logs, e.g "--audit-logs-claims email --audit-logs-claims username"
- auth_
method_ stroci_ id - The ID of this resource.
- bound_
ips Sequence[str] - A CIDR whitelist with the IPs that the access is restricted to
- delete_
protection str - Protection from accidental deletion of this auth method, [true/false]
- description str
- Auth Method description
- expiration_
event_ 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
- gw_
bound_ Sequence[str]ips - A CIDR whitelist with the GW IPs that the access is restricted to
- 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]
- group
Ocids List<String> - A list of required groups ocids
- tenant
Ocid String - The Oracle Cloud tenant ID
- 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]
- audit
Logs List<String>Claims - Subclaims to include in audit logs, e.g "--audit-logs-claims email --audit-logs-claims username"
- auth
Method StringOci Id - The ID of this resource.
- bound
Ips List<String> - A CIDR whitelist with the IPs that the access is restricted to
- delete
Protection String - Protection from accidental deletion of this auth method, [true/false]
- description String
- Auth Method description
- expiration
Event 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
- gw
Bound List<String>Ips - A CIDR whitelist with the GW IPs that the access is restricted to
- 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]
Outputs
All input properties are implicitly available as output properties. Additionally, the AuthMethodOci resource produces the following output properties:
Look up Existing AuthMethodOci Resource
Get an existing AuthMethodOci 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?: AuthMethodOciState, opts?: CustomResourceOptions): AuthMethodOci@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,
audit_logs_claims: Optional[Sequence[str]] = None,
auth_method_oci_id: Optional[str] = None,
bound_ips: Optional[Sequence[str]] = None,
delete_protection: Optional[str] = None,
description: Optional[str] = None,
expiration_event_ins: Optional[Sequence[str]] = None,
force_sub_claims: Optional[bool] = None,
group_ocids: Optional[Sequence[str]] = None,
gw_bound_ips: Optional[Sequence[str]] = None,
jwt_ttl: Optional[float] = None,
name: Optional[str] = None,
product_types: Optional[Sequence[str]] = None,
tenant_ocid: Optional[str] = None) -> AuthMethodOcifunc GetAuthMethodOci(ctx *Context, name string, id IDInput, state *AuthMethodOciState, opts ...ResourceOption) (*AuthMethodOci, error)public static AuthMethodOci Get(string name, Input<string> id, AuthMethodOciState? state, CustomResourceOptions? opts = null)public static AuthMethodOci get(String name, Output<String> id, AuthMethodOciState state, CustomResourceOptions options)resources: _: type: akeyless:AuthMethodOci 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.
- 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]
- Audit
Logs List<string>Claims - Subclaims to include in audit logs, e.g "--audit-logs-claims email --audit-logs-claims username"
- Auth
Method stringOci Id - The ID of this resource.
- Bound
Ips List<string> - A CIDR whitelist with the IPs that the access is restricted to
- Delete
Protection string - Protection from accidental deletion of this auth method, [true/false]
- Description string
- Auth Method description
- Expiration
Event 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
- Group
Ocids List<string> - A list of required groups ocids
- Gw
Bound List<string>Ips - A CIDR whitelist with the GW IPs that the access is restricted to
- 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]
- Tenant
Ocid string - The Oracle Cloud tenant ID
- 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]
- Audit
Logs []stringClaims - Subclaims to include in audit logs, e.g "--audit-logs-claims email --audit-logs-claims username"
- Auth
Method stringOci Id - The ID of this resource.
- Bound
Ips []string - A CIDR whitelist with the IPs that the access is restricted to
- Delete
Protection string - Protection from accidental deletion of this auth method, [true/false]
- Description string
- Auth Method description
- Expiration
Event []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
- Group
Ocids []string - A list of required groups ocids
- Gw
Bound []stringIps - A CIDR whitelist with the GW IPs that the access is restricted to
- 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]
- Tenant
Ocid string - The Oracle Cloud tenant ID
- 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]
- audit
Logs List<String>Claims - Subclaims to include in audit logs, e.g "--audit-logs-claims email --audit-logs-claims username"
- auth
Method StringOci Id - The ID of this resource.
- bound
Ips List<String> - A CIDR whitelist with the IPs that the access is restricted to
- delete
Protection String - Protection from accidental deletion of this auth method, [true/false]
- description String
- Auth Method description
- expiration
Event 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
- group
Ocids List<String> - A list of required groups ocids
- gw
Bound List<String>Ips - A CIDR whitelist with the GW IPs that the access is restricted to
- 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]
- tenant
Ocid String - The Oracle Cloud tenant ID
- 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]
- audit
Logs string[]Claims - Subclaims to include in audit logs, e.g "--audit-logs-claims email --audit-logs-claims username"
- auth
Method stringOci Id - The ID of this resource.
- bound
Ips string[] - A CIDR whitelist with the IPs that the access is restricted to
- delete
Protection string - Protection from accidental deletion of this auth method, [true/false]
- description string
- Auth Method description
- expiration
Event 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
- group
Ocids string[] - A list of required groups ocids
- gw
Bound string[]Ips - A CIDR whitelist with the GW IPs that the access is restricted to
- 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]
- tenant
Ocid string - The Oracle Cloud tenant ID
- 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]
- audit_
logs_ Sequence[str]claims - Subclaims to include in audit logs, e.g "--audit-logs-claims email --audit-logs-claims username"
- auth_
method_ stroci_ id - The ID of this resource.
- bound_
ips Sequence[str] - A CIDR whitelist with the IPs that the access is restricted to
- delete_
protection str - Protection from accidental deletion of this auth method, [true/false]
- description str
- Auth Method description
- expiration_
event_ 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
- group_
ocids Sequence[str] - A list of required groups ocids
- gw_
bound_ Sequence[str]ips - A CIDR whitelist with the GW IPs that the access is restricted to
- 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]
- tenant_
ocid str - The Oracle Cloud tenant ID
- 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]
- audit
Logs List<String>Claims - Subclaims to include in audit logs, e.g "--audit-logs-claims email --audit-logs-claims username"
- auth
Method StringOci Id - The ID of this resource.
- bound
Ips List<String> - A CIDR whitelist with the IPs that the access is restricted to
- delete
Protection String - Protection from accidental deletion of this auth method, [true/false]
- description String
- Auth Method description
- expiration
Event 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
- group
Ocids List<String> - A list of required groups ocids
- gw
Bound List<String>Ips - A CIDR whitelist with the GW IPs that the access is restricted to
- 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]
- tenant
Ocid String - The Oracle Cloud tenant ID
Package Details
- Repository
- akeyless akeyless-community/terraform-provider-akeyless
- License
- Notes
- This Pulumi package is based on the
akeylessTerraform Provider.
published on Monday, Apr 27, 2026 by akeyless-community
