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

akeyless.GatewayAllowedAccess

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

    Create gateway allowed access

    Create GatewayAllowedAccess Resource

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

    Constructor syntax

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

@overload
def GatewayAllowedAccess(resource_name: str,
                         opts: Optional[ResourceOptions] = None,
                         access_id: Optional[str] = None,
                         access_type: Optional[str] = None,
                         case_sensitive: Optional[str] = None,
                         cluster_id: Optional[float] = None,
                         created_at: Optional[str] = None,
                         description: Optional[str] = None,
                         editable: Optional[bool] = None,
                         error: Optional[str] = None,
                         gateway_allowed_access_id: Optional[str] = None,
                         id_int: Optional[float] = None,
                         is_valid: Optional[bool] = None,
                         name: Optional[str] = None,
                         permissions: Optional[str] = None,
                         sub_claims: Optional[Mapping[str, str]] = None,
                         sub_claims_case_insensitive: Optional[bool] = None,
                         updated_at: Optional[str] = None)
    func NewGatewayAllowedAccess(ctx *Context, name string, args GatewayAllowedAccessArgs, opts ...ResourceOption) (*GatewayAllowedAccess, error)
    public GatewayAllowedAccess(string name, GatewayAllowedAccessArgs args, CustomResourceOptions? opts = null)
    public GatewayAllowedAccess(String name, GatewayAllowedAccessArgs args)
public GatewayAllowedAccess(String name, GatewayAllowedAccessArgs args, CustomResourceOptions options)

    type: akeyless:GatewayAllowedAccess
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 GatewayAllowedAccessArgs
    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 GatewayAllowedAccessArgs
    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 GatewayAllowedAccessArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args GatewayAllowedAccessArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args GatewayAllowedAccessArgs
    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 gatewayAllowedAccessResource = new Akeyless.GatewayAllowedAccess("gatewayAllowedAccessResource", new()
{
    AccessId = "string",
    AccessType = "string",
    CaseSensitive = "string",
    ClusterId = 0,
    CreatedAt = "string",
    Description = "string",
    Editable = false,
    Error = "string",
    GatewayAllowedAccessId = "string",
    IdInt = 0,
    IsValid = false,
    Name = "string",
    Permissions = "string",
    SubClaims = 
    {
        { "string", "string" },
    },
    SubClaimsCaseInsensitive = false,
    UpdatedAt = "string",
});

    example, err := akeyless.NewGatewayAllowedAccess(ctx, "gatewayAllowedAccessResource", &akeyless.GatewayAllowedAccessArgs{
	AccessId:               pulumi.String("string"),
	AccessType:             pulumi.String("string"),
	CaseSensitive:          pulumi.String("string"),
	ClusterId:              pulumi.Float64(0),
	CreatedAt:              pulumi.String("string"),
	Description:            pulumi.String("string"),
	Editable:               pulumi.Bool(false),
	Error:                  pulumi.String("string"),
	GatewayAllowedAccessId: pulumi.String("string"),
	IdInt:                  pulumi.Float64(0),
	IsValid:                pulumi.Bool(false),
	Name:                   pulumi.String("string"),
	Permissions:            pulumi.String("string"),
	SubClaims: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	SubClaimsCaseInsensitive: pulumi.Bool(false),
	UpdatedAt:                pulumi.String("string"),
})

    var gatewayAllowedAccessResource = new GatewayAllowedAccess("gatewayAllowedAccessResource", GatewayAllowedAccessArgs.builder()
    .accessId("string")
    .accessType("string")
    .caseSensitive("string")
    .clusterId(0.0)
    .createdAt("string")
    .description("string")
    .editable(false)
    .error("string")
    .gatewayAllowedAccessId("string")
    .idInt(0.0)
    .isValid(false)
    .name("string")
    .permissions("string")
    .subClaims(Map.of("string", "string"))
    .subClaimsCaseInsensitive(false)
    .updatedAt("string")
    .build());

    gateway_allowed_access_resource = akeyless.GatewayAllowedAccess("gatewayAllowedAccessResource",
    access_id="string",
    access_type="string",
    case_sensitive="string",
    cluster_id=float(0),
    created_at="string",
    description="string",
    editable=False,
    error="string",
    gateway_allowed_access_id="string",
    id_int=float(0),
    is_valid=False,
    name="string",
    permissions="string",
    sub_claims={
        "string": "string",
    },
    sub_claims_case_insensitive=False,
    updated_at="string")

    const gatewayAllowedAccessResource = new akeyless.GatewayAllowedAccess("gatewayAllowedAccessResource", {
    accessId: "string",
    accessType: "string",
    caseSensitive: "string",
    clusterId: 0,
    createdAt: "string",
    description: "string",
    editable: false,
    error: "string",
    gatewayAllowedAccessId: "string",
    idInt: 0,
    isValid: false,
    name: "string",
    permissions: "string",
    subClaims: {
        string: "string",
    },
    subClaimsCaseInsensitive: false,
    updatedAt: "string",
});

    type: akeyless:GatewayAllowedAccess
properties:
    accessId: string
    accessType: string
    caseSensitive: string
    clusterId: 0
    createdAt: string
    description: string
    editable: false
    error: string
    gatewayAllowedAccessId: string
    idInt: 0
    isValid: false
    name: string
    permissions: string
    subClaims:
        string: string
    subClaimsCaseInsensitive: false
    updatedAt: string

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

    AccessId string
    The access id to be attached to this allowed access. Auth method with this access id should already exist.
    AccessType string
    Access type
    CaseSensitive string
    Treat sub claims as case-sensitive [true/false]
    ClusterId double
    Cluster ID
    CreatedAt string
    Creation timestamp
    Description string
    Allowed access description
    Editable bool
    Whether the allowed access is editable
    Error string
    Error message if any
    GatewayAllowedAccessId string
    The ID of this resource.
    IdInt double
    Internal ID
    IsValid bool
    Whether the allowed access is valid
    Name string
    Allowed access name
    Permissions string
    Permissions Comma-seperated list of permissions for this allowed access. Available permissions: [defaults,targets,classickeys,automaticmigration,ldapauth,dynamicsecret,k8sauth,logforwarding,zeroknowledgeencryption,rotatedsecret,caching,eventforwarding,admin,kmip,general,rotatesecretvalue]
    SubClaims Dictionary<string, string>
    Sub claims key/val of sub claims, e.g group=admins,developers
    SubClaimsCaseInsensitive bool
    Treat sub claims as case-insensitive
    UpdatedAt string
    Last update timestamp
    AccessId string
    The access id to be attached to this allowed access. Auth method with this access id should already exist.
    AccessType string
    Access type
    CaseSensitive string
    Treat sub claims as case-sensitive [true/false]
    ClusterId float64
    Cluster ID
    CreatedAt string
    Creation timestamp
    Description string
    Allowed access description
    Editable bool
    Whether the allowed access is editable
    Error string
    Error message if any
    GatewayAllowedAccessId string
    The ID of this resource.
    IdInt float64
    Internal ID
    IsValid bool
    Whether the allowed access is valid
    Name string
    Allowed access name
    Permissions string
    Permissions Comma-seperated list of permissions for this allowed access. Available permissions: [defaults,targets,classickeys,automaticmigration,ldapauth,dynamicsecret,k8sauth,logforwarding,zeroknowledgeencryption,rotatedsecret,caching,eventforwarding,admin,kmip,general,rotatesecretvalue]
    SubClaims map[string]string
    Sub claims key/val of sub claims, e.g group=admins,developers
    SubClaimsCaseInsensitive bool
    Treat sub claims as case-insensitive
    UpdatedAt string
    Last update timestamp
    accessId String
    The access id to be attached to this allowed access. Auth method with this access id should already exist.
    accessType String
    Access type
    caseSensitive String
    Treat sub claims as case-sensitive [true/false]
    clusterId Double
    Cluster ID
    createdAt String
    Creation timestamp
    description String
    Allowed access description
    editable Boolean
    Whether the allowed access is editable
    error String
    Error message if any
    gatewayAllowedAccessId String
    The ID of this resource.
    idInt Double
    Internal ID
    isValid Boolean
    Whether the allowed access is valid
    name String
    Allowed access name
    permissions String
    Permissions Comma-seperated list of permissions for this allowed access. Available permissions: [defaults,targets,classickeys,automaticmigration,ldapauth,dynamicsecret,k8sauth,logforwarding,zeroknowledgeencryption,rotatedsecret,caching,eventforwarding,admin,kmip,general,rotatesecretvalue]
    subClaims Map<String,String>
    Sub claims key/val of sub claims, e.g group=admins,developers
    subClaimsCaseInsensitive Boolean
    Treat sub claims as case-insensitive
    updatedAt String
    Last update timestamp
    accessId string
    The access id to be attached to this allowed access. Auth method with this access id should already exist.
    accessType string
    Access type
    caseSensitive string
    Treat sub claims as case-sensitive [true/false]
    clusterId number
    Cluster ID
    createdAt string
    Creation timestamp
    description string
    Allowed access description
    editable boolean
    Whether the allowed access is editable
    error string
    Error message if any
    gatewayAllowedAccessId string
    The ID of this resource.
    idInt number
    Internal ID
    isValid boolean
    Whether the allowed access is valid
    name string
    Allowed access name
    permissions string
    Permissions Comma-seperated list of permissions for this allowed access. Available permissions: [defaults,targets,classickeys,automaticmigration,ldapauth,dynamicsecret,k8sauth,logforwarding,zeroknowledgeencryption,rotatedsecret,caching,eventforwarding,admin,kmip,general,rotatesecretvalue]
    subClaims {[key: string]: string}
    Sub claims key/val of sub claims, e.g group=admins,developers
    subClaimsCaseInsensitive boolean
    Treat sub claims as case-insensitive
    updatedAt string
    Last update timestamp
    access_id str
    The access id to be attached to this allowed access. Auth method with this access id should already exist.
    access_type str
    Access type
    case_sensitive str
    Treat sub claims as case-sensitive [true/false]
    cluster_id float
    Cluster ID
    created_at str
    Creation timestamp
    description str
    Allowed access description
    editable bool
    Whether the allowed access is editable
    error str
    Error message if any
    gateway_allowed_access_id str
    The ID of this resource.
    id_int float
    Internal ID
    is_valid bool
    Whether the allowed access is valid
    name str
    Allowed access name
    permissions str
    Permissions Comma-seperated list of permissions for this allowed access. Available permissions: [defaults,targets,classickeys,automaticmigration,ldapauth,dynamicsecret,k8sauth,logforwarding,zeroknowledgeencryption,rotatedsecret,caching,eventforwarding,admin,kmip,general,rotatesecretvalue]
    sub_claims Mapping[str, str]
    Sub claims key/val of sub claims, e.g group=admins,developers
    sub_claims_case_insensitive bool
    Treat sub claims as case-insensitive
    updated_at str
    Last update timestamp
    accessId String
    The access id to be attached to this allowed access. Auth method with this access id should already exist.
    accessType String
    Access type
    caseSensitive String
    Treat sub claims as case-sensitive [true/false]
    clusterId Number
    Cluster ID
    createdAt String
    Creation timestamp
    description String
    Allowed access description
    editable Boolean
    Whether the allowed access is editable
    error String
    Error message if any
    gatewayAllowedAccessId String
    The ID of this resource.
    idInt Number
    Internal ID
    isValid Boolean
    Whether the allowed access is valid
    name String
    Allowed access name
    permissions String
    Permissions Comma-seperated list of permissions for this allowed access. Available permissions: [defaults,targets,classickeys,automaticmigration,ldapauth,dynamicsecret,k8sauth,logforwarding,zeroknowledgeencryption,rotatedsecret,caching,eventforwarding,admin,kmip,general,rotatesecretvalue]
    subClaims Map<String>
    Sub claims key/val of sub claims, e.g group=admins,developers
    subClaimsCaseInsensitive Boolean
    Treat sub claims as case-insensitive
    updatedAt String
    Last update timestamp

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing GatewayAllowedAccess Resource

    Get an existing GatewayAllowedAccess 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?: GatewayAllowedAccessState, opts?: CustomResourceOptions): GatewayAllowedAccess
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        access_id: Optional[str] = None,
        access_type: Optional[str] = None,
        case_sensitive: Optional[str] = None,
        cluster_id: Optional[float] = None,
        created_at: Optional[str] = None,
        description: Optional[str] = None,
        editable: Optional[bool] = None,
        error: Optional[str] = None,
        gateway_allowed_access_id: Optional[str] = None,
        id_int: Optional[float] = None,
        is_valid: Optional[bool] = None,
        name: Optional[str] = None,
        permissions: Optional[str] = None,
        sub_claims: Optional[Mapping[str, str]] = None,
        sub_claims_case_insensitive: Optional[bool] = None,
        updated_at: Optional[str] = None) -> GatewayAllowedAccess
    func GetGatewayAllowedAccess(ctx *Context, name string, id IDInput, state *GatewayAllowedAccessState, opts ...ResourceOption) (*GatewayAllowedAccess, error)
    public static GatewayAllowedAccess Get(string name, Input<string> id, GatewayAllowedAccessState? state, CustomResourceOptions? opts = null)
    public static GatewayAllowedAccess get(String name, Output<String> id, GatewayAllowedAccessState state, CustomResourceOptions options)
    resources:  _:    type: akeyless:GatewayAllowedAccess    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:
    AccessId string
    The access id to be attached to this allowed access. Auth method with this access id should already exist.
    AccessType string
    Access type
    CaseSensitive string
    Treat sub claims as case-sensitive [true/false]
    ClusterId double
    Cluster ID
    CreatedAt string
    Creation timestamp
    Description string
    Allowed access description
    Editable bool
    Whether the allowed access is editable
    Error string
    Error message if any
    GatewayAllowedAccessId string
    The ID of this resource.
    IdInt double
    Internal ID
    IsValid bool
    Whether the allowed access is valid
    Name string
    Allowed access name
    Permissions string
    Permissions Comma-seperated list of permissions for this allowed access. Available permissions: [defaults,targets,classickeys,automaticmigration,ldapauth,dynamicsecret,k8sauth,logforwarding,zeroknowledgeencryption,rotatedsecret,caching,eventforwarding,admin,kmip,general,rotatesecretvalue]
    SubClaims Dictionary<string, string>
    Sub claims key/val of sub claims, e.g group=admins,developers
    SubClaimsCaseInsensitive bool
    Treat sub claims as case-insensitive
    UpdatedAt string
    Last update timestamp
    AccessId string
    The access id to be attached to this allowed access. Auth method with this access id should already exist.
    AccessType string
    Access type
    CaseSensitive string
    Treat sub claims as case-sensitive [true/false]
    ClusterId float64
    Cluster ID
    CreatedAt string
    Creation timestamp
    Description string
    Allowed access description
    Editable bool
    Whether the allowed access is editable
    Error string
    Error message if any
    GatewayAllowedAccessId string
    The ID of this resource.
    IdInt float64
    Internal ID
    IsValid bool
    Whether the allowed access is valid
    Name string
    Allowed access name
    Permissions string
    Permissions Comma-seperated list of permissions for this allowed access. Available permissions: [defaults,targets,classickeys,automaticmigration,ldapauth,dynamicsecret,k8sauth,logforwarding,zeroknowledgeencryption,rotatedsecret,caching,eventforwarding,admin,kmip,general,rotatesecretvalue]
    SubClaims map[string]string
    Sub claims key/val of sub claims, e.g group=admins,developers
    SubClaimsCaseInsensitive bool
    Treat sub claims as case-insensitive
    UpdatedAt string
    Last update timestamp
    accessId String
    The access id to be attached to this allowed access. Auth method with this access id should already exist.
    accessType String
    Access type
    caseSensitive String
    Treat sub claims as case-sensitive [true/false]
    clusterId Double
    Cluster ID
    createdAt String
    Creation timestamp
    description String
    Allowed access description
    editable Boolean
    Whether the allowed access is editable
    error String
    Error message if any
    gatewayAllowedAccessId String
    The ID of this resource.
    idInt Double
    Internal ID
    isValid Boolean
    Whether the allowed access is valid
    name String
    Allowed access name
    permissions String
    Permissions Comma-seperated list of permissions for this allowed access. Available permissions: [defaults,targets,classickeys,automaticmigration,ldapauth,dynamicsecret,k8sauth,logforwarding,zeroknowledgeencryption,rotatedsecret,caching,eventforwarding,admin,kmip,general,rotatesecretvalue]
    subClaims Map<String,String>
    Sub claims key/val of sub claims, e.g group=admins,developers
    subClaimsCaseInsensitive Boolean
    Treat sub claims as case-insensitive
    updatedAt String
    Last update timestamp
    accessId string
    The access id to be attached to this allowed access. Auth method with this access id should already exist.
    accessType string
    Access type
    caseSensitive string
    Treat sub claims as case-sensitive [true/false]
    clusterId number
    Cluster ID
    createdAt string
    Creation timestamp
    description string
    Allowed access description
    editable boolean
    Whether the allowed access is editable
    error string
    Error message if any
    gatewayAllowedAccessId string
    The ID of this resource.
    idInt number
    Internal ID
    isValid boolean
    Whether the allowed access is valid
    name string
    Allowed access name
    permissions string
    Permissions Comma-seperated list of permissions for this allowed access. Available permissions: [defaults,targets,classickeys,automaticmigration,ldapauth,dynamicsecret,k8sauth,logforwarding,zeroknowledgeencryption,rotatedsecret,caching,eventforwarding,admin,kmip,general,rotatesecretvalue]
    subClaims {[key: string]: string}
    Sub claims key/val of sub claims, e.g group=admins,developers
    subClaimsCaseInsensitive boolean
    Treat sub claims as case-insensitive
    updatedAt string
    Last update timestamp
    access_id str
    The access id to be attached to this allowed access. Auth method with this access id should already exist.
    access_type str
    Access type
    case_sensitive str
    Treat sub claims as case-sensitive [true/false]
    cluster_id float
    Cluster ID
    created_at str
    Creation timestamp
    description str
    Allowed access description
    editable bool
    Whether the allowed access is editable
    error str
    Error message if any
    gateway_allowed_access_id str
    The ID of this resource.
    id_int float
    Internal ID
    is_valid bool
    Whether the allowed access is valid
    name str
    Allowed access name
    permissions str
    Permissions Comma-seperated list of permissions for this allowed access. Available permissions: [defaults,targets,classickeys,automaticmigration,ldapauth,dynamicsecret,k8sauth,logforwarding,zeroknowledgeencryption,rotatedsecret,caching,eventforwarding,admin,kmip,general,rotatesecretvalue]
    sub_claims Mapping[str, str]
    Sub claims key/val of sub claims, e.g group=admins,developers
    sub_claims_case_insensitive bool
    Treat sub claims as case-insensitive
    updated_at str
    Last update timestamp
    accessId String
    The access id to be attached to this allowed access. Auth method with this access id should already exist.
    accessType String
    Access type
    caseSensitive String
    Treat sub claims as case-sensitive [true/false]
    clusterId Number
    Cluster ID
    createdAt String
    Creation timestamp
    description String
    Allowed access description
    editable Boolean
    Whether the allowed access is editable
    error String
    Error message if any
    gatewayAllowedAccessId String
    The ID of this resource.
    idInt Number
    Internal ID
    isValid Boolean
    Whether the allowed access is valid
    name String
    Allowed access name
    permissions String
    Permissions Comma-seperated list of permissions for this allowed access. Available permissions: [defaults,targets,classickeys,automaticmigration,ldapauth,dynamicsecret,k8sauth,logforwarding,zeroknowledgeencryption,rotatedsecret,caching,eventforwarding,admin,kmip,general,rotatesecretvalue]
    subClaims Map<String>
    Sub claims key/val of sub claims, e.g group=admins,developers
    subClaimsCaseInsensitive Boolean
    Treat sub claims as case-insensitive
    updatedAt String
    Last update timestamp

    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.