1. Packages
  2. Akeyless Provider
  3. API Docs
  4. AuthMethodUniversalIdentity
akeyless 1.9.0 published on Monday, Apr 14, 2025 by akeyless-community

akeyless.AuthMethodUniversalIdentity

Explore with Pulumi AI

akeyless logo
akeyless 1.9.0 published on Monday, Apr 14, 2025 by akeyless-community

    Akeyless Universal Identity Auth Method Resource

    Create AuthMethodUniversalIdentity Resource

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

    Constructor syntax

    new AuthMethodUniversalIdentity(name: string, args?: AuthMethodUniversalIdentityArgs, opts?: CustomResourceOptions);
    @overload
    def AuthMethodUniversalIdentity(resource_name: str,
                                    args: Optional[AuthMethodUniversalIdentityArgs] = None,
                                    opts: Optional[ResourceOptions] = None)
    
    @overload
    def AuthMethodUniversalIdentity(resource_name: str,
                                    opts: Optional[ResourceOptions] = None,
                                    access_expires: Optional[float] = None,
                                    audit_logs_claims: Optional[Sequence[str]] = None,
                                    auth_method_universal_identity_id: Optional[str] = None,
                                    bound_ips: Optional[Sequence[str]] = None,
                                    delete_protection: Optional[str] = None,
                                    deny_inheritance: Optional[bool] = None,
                                    deny_rotate: Optional[bool] = None,
                                    force_sub_claims: Optional[bool] = None,
                                    jwt_ttl: Optional[float] = None,
                                    name: Optional[str] = None,
                                    ttl: Optional[float] = None)
    func NewAuthMethodUniversalIdentity(ctx *Context, name string, args *AuthMethodUniversalIdentityArgs, opts ...ResourceOption) (*AuthMethodUniversalIdentity, error)
    public AuthMethodUniversalIdentity(string name, AuthMethodUniversalIdentityArgs? args = null, CustomResourceOptions? opts = null)
    public AuthMethodUniversalIdentity(String name, AuthMethodUniversalIdentityArgs args)
    public AuthMethodUniversalIdentity(String name, AuthMethodUniversalIdentityArgs args, CustomResourceOptions options)
    
    type: akeyless:AuthMethodUniversalIdentity
    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 AuthMethodUniversalIdentityArgs
    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 AuthMethodUniversalIdentityArgs
    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 AuthMethodUniversalIdentityArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args AuthMethodUniversalIdentityArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args AuthMethodUniversalIdentityArgs
    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 authMethodUniversalIdentityResource = new Akeyless.AuthMethodUniversalIdentity("authMethodUniversalIdentityResource", new()
    {
        AccessExpires = 0,
        AuditLogsClaims = new[]
        {
            "string",
        },
        AuthMethodUniversalIdentityId = "string",
        BoundIps = new[]
        {
            "string",
        },
        DeleteProtection = "string",
        DenyInheritance = false,
        DenyRotate = false,
        ForceSubClaims = false,
        JwtTtl = 0,
        Name = "string",
        Ttl = 0,
    });
    
    example, err := akeyless.NewAuthMethodUniversalIdentity(ctx, "authMethodUniversalIdentityResource", &akeyless.AuthMethodUniversalIdentityArgs{
    	AccessExpires: pulumi.Float64(0),
    	AuditLogsClaims: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	AuthMethodUniversalIdentityId: pulumi.String("string"),
    	BoundIps: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	DeleteProtection: pulumi.String("string"),
    	DenyInheritance:  pulumi.Bool(false),
    	DenyRotate:       pulumi.Bool(false),
    	ForceSubClaims:   pulumi.Bool(false),
    	JwtTtl:           pulumi.Float64(0),
    	Name:             pulumi.String("string"),
    	Ttl:              pulumi.Float64(0),
    })
    
    var authMethodUniversalIdentityResource = new AuthMethodUniversalIdentity("authMethodUniversalIdentityResource", AuthMethodUniversalIdentityArgs.builder()
        .accessExpires(0)
        .auditLogsClaims("string")
        .authMethodUniversalIdentityId("string")
        .boundIps("string")
        .deleteProtection("string")
        .denyInheritance(false)
        .denyRotate(false)
        .forceSubClaims(false)
        .jwtTtl(0)
        .name("string")
        .ttl(0)
        .build());
    
    auth_method_universal_identity_resource = akeyless.AuthMethodUniversalIdentity("authMethodUniversalIdentityResource",
        access_expires=0,
        audit_logs_claims=["string"],
        auth_method_universal_identity_id="string",
        bound_ips=["string"],
        delete_protection="string",
        deny_inheritance=False,
        deny_rotate=False,
        force_sub_claims=False,
        jwt_ttl=0,
        name="string",
        ttl=0)
    
    const authMethodUniversalIdentityResource = new akeyless.AuthMethodUniversalIdentity("authMethodUniversalIdentityResource", {
        accessExpires: 0,
        auditLogsClaims: ["string"],
        authMethodUniversalIdentityId: "string",
        boundIps: ["string"],
        deleteProtection: "string",
        denyInheritance: false,
        denyRotate: false,
        forceSubClaims: false,
        jwtTtl: 0,
        name: "string",
        ttl: 0,
    });
    
    type: akeyless:AuthMethodUniversalIdentity
    properties:
        accessExpires: 0
        auditLogsClaims:
            - string
        authMethodUniversalIdentityId: string
        boundIps:
            - string
        deleteProtection: string
        denyInheritance: false
        denyRotate: false
        forceSubClaims: false
        jwtTtl: 0
        name: string
        ttl: 0
    

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

    AccessExpires double
    Access expiration date in Unix timestamp (select 0 for access without expiry date)
    AuditLogsClaims List<string>
    Subclaims to include in audit logs
    AuthMethodUniversalIdentityId string
    The ID of this resource.
    BoundIps List<string>
    A CIDR whitelist with the IPs that the access is restricted to
    DeleteProtection string
    Protection from accidental deletion of this auth method, [true/false]
    DenyInheritance bool
    Deny from root to create children
    DenyRotate bool
    Deny from the token to rotate
    ForceSubClaims bool
    enforce role-association must include sub claims
    JwtTtl double
    Creds expiration time in minutes
    Name string
    Auth Method name
    Ttl double
    Token ttl (in minutes)
    AccessExpires float64
    Access expiration date in Unix timestamp (select 0 for access without expiry date)
    AuditLogsClaims []string
    Subclaims to include in audit logs
    AuthMethodUniversalIdentityId string
    The ID of this resource.
    BoundIps []string
    A CIDR whitelist with the IPs that the access is restricted to
    DeleteProtection string
    Protection from accidental deletion of this auth method, [true/false]
    DenyInheritance bool
    Deny from root to create children
    DenyRotate bool
    Deny from the token to rotate
    ForceSubClaims bool
    enforce role-association must include sub claims
    JwtTtl float64
    Creds expiration time in minutes
    Name string
    Auth Method name
    Ttl float64
    Token ttl (in minutes)
    accessExpires Double
    Access expiration date in Unix timestamp (select 0 for access without expiry date)
    auditLogsClaims List<String>
    Subclaims to include in audit logs
    authMethodUniversalIdentityId String
    The ID of this resource.
    boundIps List<String>
    A CIDR whitelist with the IPs that the access is restricted to
    deleteProtection String
    Protection from accidental deletion of this auth method, [true/false]
    denyInheritance Boolean
    Deny from root to create children
    denyRotate Boolean
    Deny from the token to rotate
    forceSubClaims Boolean
    enforce role-association must include sub claims
    jwtTtl Double
    Creds expiration time in minutes
    name String
    Auth Method name
    ttl Double
    Token ttl (in minutes)
    accessExpires number
    Access expiration date in Unix timestamp (select 0 for access without expiry date)
    auditLogsClaims string[]
    Subclaims to include in audit logs
    authMethodUniversalIdentityId string
    The ID of this resource.
    boundIps string[]
    A CIDR whitelist with the IPs that the access is restricted to
    deleteProtection string
    Protection from accidental deletion of this auth method, [true/false]
    denyInheritance boolean
    Deny from root to create children
    denyRotate boolean
    Deny from the token to rotate
    forceSubClaims boolean
    enforce role-association must include sub claims
    jwtTtl number
    Creds expiration time in minutes
    name string
    Auth Method name
    ttl number
    Token ttl (in minutes)
    access_expires float
    Access expiration date in Unix timestamp (select 0 for access without expiry date)
    audit_logs_claims Sequence[str]
    Subclaims to include in audit logs
    auth_method_universal_identity_id str
    The ID of this resource.
    bound_ips Sequence[str]
    A CIDR whitelist with the IPs that the access is restricted to
    delete_protection str
    Protection from accidental deletion of this auth method, [true/false]
    deny_inheritance bool
    Deny from root to create children
    deny_rotate bool
    Deny from the token to rotate
    force_sub_claims bool
    enforce role-association must include sub claims
    jwt_ttl float
    Creds expiration time in minutes
    name str
    Auth Method name
    ttl float
    Token ttl (in minutes)
    accessExpires Number
    Access expiration date in Unix timestamp (select 0 for access without expiry date)
    auditLogsClaims List<String>
    Subclaims to include in audit logs
    authMethodUniversalIdentityId String
    The ID of this resource.
    boundIps List<String>
    A CIDR whitelist with the IPs that the access is restricted to
    deleteProtection String
    Protection from accidental deletion of this auth method, [true/false]
    denyInheritance Boolean
    Deny from root to create children
    denyRotate Boolean
    Deny from the token to rotate
    forceSubClaims Boolean
    enforce role-association must include sub claims
    jwtTtl Number
    Creds expiration time in minutes
    name String
    Auth Method name
    ttl Number
    Token ttl (in minutes)

    Outputs

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

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

    Look up Existing AuthMethodUniversalIdentity Resource

    Get an existing AuthMethodUniversalIdentity 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?: AuthMethodUniversalIdentityState, opts?: CustomResourceOptions): AuthMethodUniversalIdentity
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            access_expires: Optional[float] = None,
            access_id: Optional[str] = None,
            audit_logs_claims: Optional[Sequence[str]] = None,
            auth_method_universal_identity_id: Optional[str] = None,
            bound_ips: Optional[Sequence[str]] = None,
            delete_protection: Optional[str] = None,
            deny_inheritance: Optional[bool] = None,
            deny_rotate: Optional[bool] = None,
            force_sub_claims: Optional[bool] = None,
            jwt_ttl: Optional[float] = None,
            name: Optional[str] = None,
            ttl: Optional[float] = None) -> AuthMethodUniversalIdentity
    func GetAuthMethodUniversalIdentity(ctx *Context, name string, id IDInput, state *AuthMethodUniversalIdentityState, opts ...ResourceOption) (*AuthMethodUniversalIdentity, error)
    public static AuthMethodUniversalIdentity Get(string name, Input<string> id, AuthMethodUniversalIdentityState? state, CustomResourceOptions? opts = null)
    public static AuthMethodUniversalIdentity get(String name, Output<String> id, AuthMethodUniversalIdentityState state, CustomResourceOptions options)
    resources:  _:    type: akeyless:AuthMethodUniversalIdentity    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    AccessExpires double
    Access expiration date in Unix timestamp (select 0 for access without expiry date)
    AccessId string
    Auth Method access ID
    AuditLogsClaims List<string>
    Subclaims to include in audit logs
    AuthMethodUniversalIdentityId string
    The ID of this resource.
    BoundIps List<string>
    A CIDR whitelist with the IPs that the access is restricted to
    DeleteProtection string
    Protection from accidental deletion of this auth method, [true/false]
    DenyInheritance bool
    Deny from root to create children
    DenyRotate bool
    Deny from the token to rotate
    ForceSubClaims bool
    enforce role-association must include sub claims
    JwtTtl double
    Creds expiration time in minutes
    Name string
    Auth Method name
    Ttl double
    Token ttl (in minutes)
    AccessExpires float64
    Access expiration date in Unix timestamp (select 0 for access without expiry date)
    AccessId string
    Auth Method access ID
    AuditLogsClaims []string
    Subclaims to include in audit logs
    AuthMethodUniversalIdentityId string
    The ID of this resource.
    BoundIps []string
    A CIDR whitelist with the IPs that the access is restricted to
    DeleteProtection string
    Protection from accidental deletion of this auth method, [true/false]
    DenyInheritance bool
    Deny from root to create children
    DenyRotate bool
    Deny from the token to rotate
    ForceSubClaims bool
    enforce role-association must include sub claims
    JwtTtl float64
    Creds expiration time in minutes
    Name string
    Auth Method name
    Ttl float64
    Token ttl (in minutes)
    accessExpires Double
    Access expiration date in Unix timestamp (select 0 for access without expiry date)
    accessId String
    Auth Method access ID
    auditLogsClaims List<String>
    Subclaims to include in audit logs
    authMethodUniversalIdentityId String
    The ID of this resource.
    boundIps List<String>
    A CIDR whitelist with the IPs that the access is restricted to
    deleteProtection String
    Protection from accidental deletion of this auth method, [true/false]
    denyInheritance Boolean
    Deny from root to create children
    denyRotate Boolean
    Deny from the token to rotate
    forceSubClaims Boolean
    enforce role-association must include sub claims
    jwtTtl Double
    Creds expiration time in minutes
    name String
    Auth Method name
    ttl Double
    Token ttl (in minutes)
    accessExpires number
    Access expiration date in Unix timestamp (select 0 for access without expiry date)
    accessId string
    Auth Method access ID
    auditLogsClaims string[]
    Subclaims to include in audit logs
    authMethodUniversalIdentityId string
    The ID of this resource.
    boundIps string[]
    A CIDR whitelist with the IPs that the access is restricted to
    deleteProtection string
    Protection from accidental deletion of this auth method, [true/false]
    denyInheritance boolean
    Deny from root to create children
    denyRotate boolean
    Deny from the token to rotate
    forceSubClaims boolean
    enforce role-association must include sub claims
    jwtTtl number
    Creds expiration time in minutes
    name string
    Auth Method name
    ttl number
    Token ttl (in minutes)
    access_expires float
    Access expiration date in Unix timestamp (select 0 for access without expiry date)
    access_id str
    Auth Method access ID
    audit_logs_claims Sequence[str]
    Subclaims to include in audit logs
    auth_method_universal_identity_id str
    The ID of this resource.
    bound_ips Sequence[str]
    A CIDR whitelist with the IPs that the access is restricted to
    delete_protection str
    Protection from accidental deletion of this auth method, [true/false]
    deny_inheritance bool
    Deny from root to create children
    deny_rotate bool
    Deny from the token to rotate
    force_sub_claims bool
    enforce role-association must include sub claims
    jwt_ttl float
    Creds expiration time in minutes
    name str
    Auth Method name
    ttl float
    Token ttl (in minutes)
    accessExpires Number
    Access expiration date in Unix timestamp (select 0 for access without expiry date)
    accessId String
    Auth Method access ID
    auditLogsClaims List<String>
    Subclaims to include in audit logs
    authMethodUniversalIdentityId String
    The ID of this resource.
    boundIps List<String>
    A CIDR whitelist with the IPs that the access is restricted to
    deleteProtection String
    Protection from accidental deletion of this auth method, [true/false]
    denyInheritance Boolean
    Deny from root to create children
    denyRotate Boolean
    Deny from the token to rotate
    forceSubClaims Boolean
    enforce role-association must include sub claims
    jwtTtl Number
    Creds expiration time in minutes
    name String
    Auth Method name
    ttl Number
    Token ttl (in minutes)

    Package Details

    Repository
    akeyless akeyless-community/terraform-provider-akeyless
    License
    Notes
    This Pulumi package is based on the akeyless Terraform Provider.
    akeyless logo
    akeyless 1.9.0 published on Monday, Apr 14, 2025 by akeyless-community