1. Packages
  2. Avi Provider
  3. API Docs
  4. Authprofile
avi 31.1.1 published on Monday, Apr 14, 2025 by vmware

avi.Authprofile

Explore with Pulumi AI

<!–

Copyright 2021 VMware, Inc.
SPDX-License-Identifier: Mozilla Public License 2.0

–>

layout: “avi”

page_title: “Avi: avi.Authprofile” sidebar_current: “docs-avi-resource-authprofile” description: |- Creates and manages Avi AuthProfile.

avi.Authprofile

The AuthProfile resource allows the creation and management of Avi AuthProfile

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as avi from "@pulumi/avi";

const foo = new avi.Authprofile("foo", {tenantRef: "/api/tenant/?name=admin"});
Copy
import pulumi
import pulumi_avi as avi

foo = avi.Authprofile("foo", tenant_ref="/api/tenant/?name=admin")
Copy
package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/avi/v31/avi"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := avi.NewAuthprofile(ctx, "foo", &avi.AuthprofileArgs{
			TenantRef: pulumi.String("/api/tenant/?name=admin"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Avi = Pulumi.Avi;

return await Deployment.RunAsync(() => 
{
    var foo = new Avi.Authprofile("foo", new()
    {
        TenantRef = "/api/tenant/?name=admin",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.avi.Authprofile;
import com.pulumi.avi.AuthprofileArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var foo = new Authprofile("foo", AuthprofileArgs.builder()
            .tenantRef("/api/tenant/?name=admin")
            .build());

    }
}
Copy
resources:
  foo:
    type: avi:Authprofile
    properties:
      tenantRef: /api/tenant/?name=admin
Copy

Create Authprofile Resource

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

Constructor syntax

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

@overload
def Authprofile(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                type: Optional[str] = None,
                markers: Optional[Sequence[AuthprofileMarkerArgs]] = None,
                description: Optional[str] = None,
                https: Optional[Sequence[AuthprofileHttpArgs]] = None,
                jwt_profile_ref: Optional[str] = None,
                ldaps: Optional[Sequence[AuthprofileLdapArgs]] = None,
                authprofile_id: Optional[str] = None,
                name: Optional[str] = None,
                oauth_profiles: Optional[Sequence[AuthprofileOauthProfileArgs]] = None,
                samls: Optional[Sequence[AuthprofileSamlArgs]] = None,
                tacacs_pluses: Optional[Sequence[AuthprofileTacacsPlusArgs]] = None,
                tenant_ref: Optional[str] = None,
                configpb_attributes: Optional[Sequence[AuthprofileConfigpbAttributeArgs]] = None,
                uuid: Optional[str] = None)
func NewAuthprofile(ctx *Context, name string, args AuthprofileArgs, opts ...ResourceOption) (*Authprofile, error)
public Authprofile(string name, AuthprofileArgs args, CustomResourceOptions? opts = null)
public Authprofile(String name, AuthprofileArgs args)
public Authprofile(String name, AuthprofileArgs args, CustomResourceOptions options)
type: avi:Authprofile
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. AuthprofileArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. AuthprofileArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. AuthprofileArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. AuthprofileArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. AuthprofileArgs
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 authprofileResource = new Avi.Authprofile("authprofileResource", new()
{
    Type = "string",
    Markers = new[]
    {
        new Avi.Inputs.AuthprofileMarkerArgs
        {
            Key = "string",
            Values = new[]
            {
                "string",
            },
        },
    },
    Description = "string",
    Https = new[]
    {
        new Avi.Inputs.AuthprofileHttpArgs
        {
            CacheExpirationTime = "string",
            RequestHeader = "string",
            RequireUserGroups = new[]
            {
                "string",
            },
        },
    },
    JwtProfileRef = "string",
    Ldaps = new[]
    {
        new Avi.Inputs.AuthprofileLdapArgs
        {
            Servers = new[]
            {
                "string",
            },
            BaseDn = "string",
            BindAsAdministrator = "string",
            EmailAttribute = "string",
            FullNameAttribute = "string",
            Port = "string",
            SecurityMode = "string",
            Settings = new[]
            {
                new Avi.Inputs.AuthprofileLdapSettingArgs
                {
                    AdminBindDn = "string",
                    Password = "string",
                    UserIdAttribute = "string",
                    GroupFilter = "string",
                    GroupMemberAttribute = "string",
                    GroupMemberIsFullDn = "string",
                    GroupSearchDn = "string",
                    GroupSearchScope = "string",
                    IgnoreReferrals = "string",
                    UserAttributes = new[]
                    {
                        "string",
                    },
                    UserSearchDn = "string",
                    UserSearchScope = "string",
                },
            },
            UserBinds = new[]
            {
                new Avi.Inputs.AuthprofileLdapUserBindArgs
                {
                    DnTemplate = "string",
                    UserIdAttribute = "string",
                    Token = "string",
                    UserAttributes = new[]
                    {
                        "string",
                    },
                },
            },
        },
    },
    AuthprofileId = "string",
    Name = "string",
    OauthProfiles = new[]
    {
        new Avi.Inputs.AuthprofileOauthProfileArgs
        {
            AuthorizationEndpoint = "string",
            EndSessionEndpoint = "string",
            InstanceId = "string",
            IntrospectionEndpoint = "string",
            Issuer = "string",
            JwksTimeout = "string",
            JwksUri = "string",
            OauthControllerSettings = new[]
            {
                new Avi.Inputs.AuthprofileOauthProfileOauthControllerSettingArgs
                {
                    ClientId = "string",
                    ClientSecret = "string",
                    OidcConfigs = new[]
                    {
                        new Avi.Inputs.AuthprofileOauthProfileOauthControllerSettingOidcConfigArgs
                        {
                            OidcEnable = "string",
                            Profile = "string",
                            Userinfo = "string",
                        },
                    },
                    Scopes = new[]
                    {
                        "string",
                    },
                },
            },
            OauthProfileType = "string",
            OauthProvider = "string",
            OauthRespBufferSz = "string",
            OrgId = "string",
            PoolRef = "string",
            RedirectUri = "string",
            ServiceId = "string",
            ServiceName = "string",
            TokenEndpoint = "string",
            UserinfoEndpoint = "string",
        },
    },
    Samls = new[]
    {
        new Avi.Inputs.AuthprofileSamlArgs
        {
            Idps = new[]
            {
                new Avi.Inputs.AuthprofileSamlIdpArgs
                {
                    MetaDataDownloadInterval = "string",
                    Metadata = "string",
                    MetadataUrl = "string",
                    PeriodicDownload = "string",
                },
            },
            Sps = new[]
            {
                new Avi.Inputs.AuthprofileSamlSpArgs
                {
                    Fqdn = "string",
                    OrgDisplayName = "string",
                    OrgName = "string",
                    OrgUrl = "string",
                    SamlEntityType = "string",
                    SpNodes = new[]
                    {
                        new Avi.Inputs.AuthprofileSamlSpSpNodeArgs
                        {
                            Name = "string",
                            EntityId = "string",
                            SigningSslKeyAndCertificateRef = "string",
                            SingleSignonUrl = "string",
                        },
                    },
                    TechContactEmail = "string",
                    TechContactName = "string",
                },
            },
        },
    },
    TacacsPluses = new[]
    {
        new Avi.Inputs.AuthprofileTacacsPlusArgs
        {
            Servers = new[]
            {
                "string",
            },
            AuthorizationAttrs = new[]
            {
                new Avi.Inputs.AuthprofileTacacsPlusAuthorizationAttrArgs
                {
                    Mandatory = "string",
                    Name = "string",
                    Value = "string",
                },
            },
            Password = "string",
            Port = "string",
            Service = "string",
        },
    },
    TenantRef = "string",
    ConfigpbAttributes = new[]
    {
        new Avi.Inputs.AuthprofileConfigpbAttributeArgs
        {
            Version = "string",
        },
    },
    Uuid = "string",
});
Copy
example, err := avi.NewAuthprofile(ctx, "authprofileResource", &avi.AuthprofileArgs{
	Type: pulumi.String("string"),
	Markers: avi.AuthprofileMarkerArray{
		&avi.AuthprofileMarkerArgs{
			Key: pulumi.String("string"),
			Values: pulumi.StringArray{
				pulumi.String("string"),
			},
		},
	},
	Description: pulumi.String("string"),
	Https: avi.AuthprofileHttpArray{
		&avi.AuthprofileHttpArgs{
			CacheExpirationTime: pulumi.String("string"),
			RequestHeader:       pulumi.String("string"),
			RequireUserGroups: pulumi.StringArray{
				pulumi.String("string"),
			},
		},
	},
	JwtProfileRef: pulumi.String("string"),
	Ldaps: avi.AuthprofileLdapArray{
		&avi.AuthprofileLdapArgs{
			Servers: pulumi.StringArray{
				pulumi.String("string"),
			},
			BaseDn:              pulumi.String("string"),
			BindAsAdministrator: pulumi.String("string"),
			EmailAttribute:      pulumi.String("string"),
			FullNameAttribute:   pulumi.String("string"),
			Port:                pulumi.String("string"),
			SecurityMode:        pulumi.String("string"),
			Settings: avi.AuthprofileLdapSettingArray{
				&avi.AuthprofileLdapSettingArgs{
					AdminBindDn:          pulumi.String("string"),
					Password:             pulumi.String("string"),
					UserIdAttribute:      pulumi.String("string"),
					GroupFilter:          pulumi.String("string"),
					GroupMemberAttribute: pulumi.String("string"),
					GroupMemberIsFullDn:  pulumi.String("string"),
					GroupSearchDn:        pulumi.String("string"),
					GroupSearchScope:     pulumi.String("string"),
					IgnoreReferrals:      pulumi.String("string"),
					UserAttributes: pulumi.StringArray{
						pulumi.String("string"),
					},
					UserSearchDn:    pulumi.String("string"),
					UserSearchScope: pulumi.String("string"),
				},
			},
			UserBinds: avi.AuthprofileLdapUserBindArray{
				&avi.AuthprofileLdapUserBindArgs{
					DnTemplate:      pulumi.String("string"),
					UserIdAttribute: pulumi.String("string"),
					Token:           pulumi.String("string"),
					UserAttributes: pulumi.StringArray{
						pulumi.String("string"),
					},
				},
			},
		},
	},
	AuthprofileId: pulumi.String("string"),
	Name:          pulumi.String("string"),
	OauthProfiles: avi.AuthprofileOauthProfileArray{
		&avi.AuthprofileOauthProfileArgs{
			AuthorizationEndpoint: pulumi.String("string"),
			EndSessionEndpoint:    pulumi.String("string"),
			InstanceId:            pulumi.String("string"),
			IntrospectionEndpoint: pulumi.String("string"),
			Issuer:                pulumi.String("string"),
			JwksTimeout:           pulumi.String("string"),
			JwksUri:               pulumi.String("string"),
			OauthControllerSettings: avi.AuthprofileOauthProfileOauthControllerSettingArray{
				&avi.AuthprofileOauthProfileOauthControllerSettingArgs{
					ClientId:     pulumi.String("string"),
					ClientSecret: pulumi.String("string"),
					OidcConfigs: avi.AuthprofileOauthProfileOauthControllerSettingOidcConfigArray{
						&avi.AuthprofileOauthProfileOauthControllerSettingOidcConfigArgs{
							OidcEnable: pulumi.String("string"),
							Profile:    pulumi.String("string"),
							Userinfo:   pulumi.String("string"),
						},
					},
					Scopes: pulumi.StringArray{
						pulumi.String("string"),
					},
				},
			},
			OauthProfileType:  pulumi.String("string"),
			OauthProvider:     pulumi.String("string"),
			OauthRespBufferSz: pulumi.String("string"),
			OrgId:             pulumi.String("string"),
			PoolRef:           pulumi.String("string"),
			RedirectUri:       pulumi.String("string"),
			ServiceId:         pulumi.String("string"),
			ServiceName:       pulumi.String("string"),
			TokenEndpoint:     pulumi.String("string"),
			UserinfoEndpoint:  pulumi.String("string"),
		},
	},
	Samls: avi.AuthprofileSamlArray{
		&avi.AuthprofileSamlArgs{
			Idps: avi.AuthprofileSamlIdpArray{
				&avi.AuthprofileSamlIdpArgs{
					MetaDataDownloadInterval: pulumi.String("string"),
					Metadata:                 pulumi.String("string"),
					MetadataUrl:              pulumi.String("string"),
					PeriodicDownload:         pulumi.String("string"),
				},
			},
			Sps: avi.AuthprofileSamlSpArray{
				&avi.AuthprofileSamlSpArgs{
					Fqdn:           pulumi.String("string"),
					OrgDisplayName: pulumi.String("string"),
					OrgName:        pulumi.String("string"),
					OrgUrl:         pulumi.String("string"),
					SamlEntityType: pulumi.String("string"),
					SpNodes: avi.AuthprofileSamlSpSpNodeArray{
						&avi.AuthprofileSamlSpSpNodeArgs{
							Name:                           pulumi.String("string"),
							EntityId:                       pulumi.String("string"),
							SigningSslKeyAndCertificateRef: pulumi.String("string"),
							SingleSignonUrl:                pulumi.String("string"),
						},
					},
					TechContactEmail: pulumi.String("string"),
					TechContactName:  pulumi.String("string"),
				},
			},
		},
	},
	TacacsPluses: avi.AuthprofileTacacsPlusArray{
		&avi.AuthprofileTacacsPlusArgs{
			Servers: pulumi.StringArray{
				pulumi.String("string"),
			},
			AuthorizationAttrs: avi.AuthprofileTacacsPlusAuthorizationAttrArray{
				&avi.AuthprofileTacacsPlusAuthorizationAttrArgs{
					Mandatory: pulumi.String("string"),
					Name:      pulumi.String("string"),
					Value:     pulumi.String("string"),
				},
			},
			Password: pulumi.String("string"),
			Port:     pulumi.String("string"),
			Service:  pulumi.String("string"),
		},
	},
	TenantRef: pulumi.String("string"),
	ConfigpbAttributes: avi.AuthprofileConfigpbAttributeArray{
		&avi.AuthprofileConfigpbAttributeArgs{
			Version: pulumi.String("string"),
		},
	},
	Uuid: pulumi.String("string"),
})
Copy
var authprofileResource = new Authprofile("authprofileResource", AuthprofileArgs.builder()
    .type("string")
    .markers(AuthprofileMarkerArgs.builder()
        .key("string")
        .values("string")
        .build())
    .description("string")
    .https(AuthprofileHttpArgs.builder()
        .cacheExpirationTime("string")
        .requestHeader("string")
        .requireUserGroups("string")
        .build())
    .jwtProfileRef("string")
    .ldaps(AuthprofileLdapArgs.builder()
        .servers("string")
        .baseDn("string")
        .bindAsAdministrator("string")
        .emailAttribute("string")
        .fullNameAttribute("string")
        .port("string")
        .securityMode("string")
        .settings(AuthprofileLdapSettingArgs.builder()
            .adminBindDn("string")
            .password("string")
            .userIdAttribute("string")
            .groupFilter("string")
            .groupMemberAttribute("string")
            .groupMemberIsFullDn("string")
            .groupSearchDn("string")
            .groupSearchScope("string")
            .ignoreReferrals("string")
            .userAttributes("string")
            .userSearchDn("string")
            .userSearchScope("string")
            .build())
        .userBinds(AuthprofileLdapUserBindArgs.builder()
            .dnTemplate("string")
            .userIdAttribute("string")
            .token("string")
            .userAttributes("string")
            .build())
        .build())
    .authprofileId("string")
    .name("string")
    .oauthProfiles(AuthprofileOauthProfileArgs.builder()
        .authorizationEndpoint("string")
        .endSessionEndpoint("string")
        .instanceId("string")
        .introspectionEndpoint("string")
        .issuer("string")
        .jwksTimeout("string")
        .jwksUri("string")
        .oauthControllerSettings(AuthprofileOauthProfileOauthControllerSettingArgs.builder()
            .clientId("string")
            .clientSecret("string")
            .oidcConfigs(AuthprofileOauthProfileOauthControllerSettingOidcConfigArgs.builder()
                .oidcEnable("string")
                .profile("string")
                .userinfo("string")
                .build())
            .scopes("string")
            .build())
        .oauthProfileType("string")
        .oauthProvider("string")
        .oauthRespBufferSz("string")
        .orgId("string")
        .poolRef("string")
        .redirectUri("string")
        .serviceId("string")
        .serviceName("string")
        .tokenEndpoint("string")
        .userinfoEndpoint("string")
        .build())
    .samls(AuthprofileSamlArgs.builder()
        .idps(AuthprofileSamlIdpArgs.builder()
            .metaDataDownloadInterval("string")
            .metadata("string")
            .metadataUrl("string")
            .periodicDownload("string")
            .build())
        .sps(AuthprofileSamlSpArgs.builder()
            .fqdn("string")
            .orgDisplayName("string")
            .orgName("string")
            .orgUrl("string")
            .samlEntityType("string")
            .spNodes(AuthprofileSamlSpSpNodeArgs.builder()
                .name("string")
                .entityId("string")
                .signingSslKeyAndCertificateRef("string")
                .singleSignonUrl("string")
                .build())
            .techContactEmail("string")
            .techContactName("string")
            .build())
        .build())
    .tacacsPluses(AuthprofileTacacsPlusArgs.builder()
        .servers("string")
        .authorizationAttrs(AuthprofileTacacsPlusAuthorizationAttrArgs.builder()
            .mandatory("string")
            .name("string")
            .value("string")
            .build())
        .password("string")
        .port("string")
        .service("string")
        .build())
    .tenantRef("string")
    .configpbAttributes(AuthprofileConfigpbAttributeArgs.builder()
        .version("string")
        .build())
    .uuid("string")
    .build());
Copy
authprofile_resource = avi.Authprofile("authprofileResource",
    type="string",
    markers=[{
        "key": "string",
        "values": ["string"],
    }],
    description="string",
    https=[{
        "cache_expiration_time": "string",
        "request_header": "string",
        "require_user_groups": ["string"],
    }],
    jwt_profile_ref="string",
    ldaps=[{
        "servers": ["string"],
        "base_dn": "string",
        "bind_as_administrator": "string",
        "email_attribute": "string",
        "full_name_attribute": "string",
        "port": "string",
        "security_mode": "string",
        "settings": [{
            "admin_bind_dn": "string",
            "password": "string",
            "user_id_attribute": "string",
            "group_filter": "string",
            "group_member_attribute": "string",
            "group_member_is_full_dn": "string",
            "group_search_dn": "string",
            "group_search_scope": "string",
            "ignore_referrals": "string",
            "user_attributes": ["string"],
            "user_search_dn": "string",
            "user_search_scope": "string",
        }],
        "user_binds": [{
            "dn_template": "string",
            "user_id_attribute": "string",
            "token": "string",
            "user_attributes": ["string"],
        }],
    }],
    authprofile_id="string",
    name="string",
    oauth_profiles=[{
        "authorization_endpoint": "string",
        "end_session_endpoint": "string",
        "instance_id": "string",
        "introspection_endpoint": "string",
        "issuer": "string",
        "jwks_timeout": "string",
        "jwks_uri": "string",
        "oauth_controller_settings": [{
            "client_id": "string",
            "client_secret": "string",
            "oidc_configs": [{
                "oidc_enable": "string",
                "profile": "string",
                "userinfo": "string",
            }],
            "scopes": ["string"],
        }],
        "oauth_profile_type": "string",
        "oauth_provider": "string",
        "oauth_resp_buffer_sz": "string",
        "org_id": "string",
        "pool_ref": "string",
        "redirect_uri": "string",
        "service_id": "string",
        "service_name": "string",
        "token_endpoint": "string",
        "userinfo_endpoint": "string",
    }],
    samls=[{
        "idps": [{
            "meta_data_download_interval": "string",
            "metadata": "string",
            "metadata_url": "string",
            "periodic_download": "string",
        }],
        "sps": [{
            "fqdn": "string",
            "org_display_name": "string",
            "org_name": "string",
            "org_url": "string",
            "saml_entity_type": "string",
            "sp_nodes": [{
                "name": "string",
                "entity_id": "string",
                "signing_ssl_key_and_certificate_ref": "string",
                "single_signon_url": "string",
            }],
            "tech_contact_email": "string",
            "tech_contact_name": "string",
        }],
    }],
    tacacs_pluses=[{
        "servers": ["string"],
        "authorization_attrs": [{
            "mandatory": "string",
            "name": "string",
            "value": "string",
        }],
        "password": "string",
        "port": "string",
        "service": "string",
    }],
    tenant_ref="string",
    configpb_attributes=[{
        "version": "string",
    }],
    uuid="string")
Copy
const authprofileResource = new avi.Authprofile("authprofileResource", {
    type: "string",
    markers: [{
        key: "string",
        values: ["string"],
    }],
    description: "string",
    https: [{
        cacheExpirationTime: "string",
        requestHeader: "string",
        requireUserGroups: ["string"],
    }],
    jwtProfileRef: "string",
    ldaps: [{
        servers: ["string"],
        baseDn: "string",
        bindAsAdministrator: "string",
        emailAttribute: "string",
        fullNameAttribute: "string",
        port: "string",
        securityMode: "string",
        settings: [{
            adminBindDn: "string",
            password: "string",
            userIdAttribute: "string",
            groupFilter: "string",
            groupMemberAttribute: "string",
            groupMemberIsFullDn: "string",
            groupSearchDn: "string",
            groupSearchScope: "string",
            ignoreReferrals: "string",
            userAttributes: ["string"],
            userSearchDn: "string",
            userSearchScope: "string",
        }],
        userBinds: [{
            dnTemplate: "string",
            userIdAttribute: "string",
            token: "string",
            userAttributes: ["string"],
        }],
    }],
    authprofileId: "string",
    name: "string",
    oauthProfiles: [{
        authorizationEndpoint: "string",
        endSessionEndpoint: "string",
        instanceId: "string",
        introspectionEndpoint: "string",
        issuer: "string",
        jwksTimeout: "string",
        jwksUri: "string",
        oauthControllerSettings: [{
            clientId: "string",
            clientSecret: "string",
            oidcConfigs: [{
                oidcEnable: "string",
                profile: "string",
                userinfo: "string",
            }],
            scopes: ["string"],
        }],
        oauthProfileType: "string",
        oauthProvider: "string",
        oauthRespBufferSz: "string",
        orgId: "string",
        poolRef: "string",
        redirectUri: "string",
        serviceId: "string",
        serviceName: "string",
        tokenEndpoint: "string",
        userinfoEndpoint: "string",
    }],
    samls: [{
        idps: [{
            metaDataDownloadInterval: "string",
            metadata: "string",
            metadataUrl: "string",
            periodicDownload: "string",
        }],
        sps: [{
            fqdn: "string",
            orgDisplayName: "string",
            orgName: "string",
            orgUrl: "string",
            samlEntityType: "string",
            spNodes: [{
                name: "string",
                entityId: "string",
                signingSslKeyAndCertificateRef: "string",
                singleSignonUrl: "string",
            }],
            techContactEmail: "string",
            techContactName: "string",
        }],
    }],
    tacacsPluses: [{
        servers: ["string"],
        authorizationAttrs: [{
            mandatory: "string",
            name: "string",
            value: "string",
        }],
        password: "string",
        port: "string",
        service: "string",
    }],
    tenantRef: "string",
    configpbAttributes: [{
        version: "string",
    }],
    uuid: "string",
});
Copy
type: avi:Authprofile
properties:
    authprofileId: string
    configpbAttributes:
        - version: string
    description: string
    https:
        - cacheExpirationTime: string
          requestHeader: string
          requireUserGroups:
            - string
    jwtProfileRef: string
    ldaps:
        - baseDn: string
          bindAsAdministrator: string
          emailAttribute: string
          fullNameAttribute: string
          port: string
          securityMode: string
          servers:
            - string
          settings:
            - adminBindDn: string
              groupFilter: string
              groupMemberAttribute: string
              groupMemberIsFullDn: string
              groupSearchDn: string
              groupSearchScope: string
              ignoreReferrals: string
              password: string
              userAttributes:
                - string
              userIdAttribute: string
              userSearchDn: string
              userSearchScope: string
          userBinds:
            - dnTemplate: string
              token: string
              userAttributes:
                - string
              userIdAttribute: string
    markers:
        - key: string
          values:
            - string
    name: string
    oauthProfiles:
        - authorizationEndpoint: string
          endSessionEndpoint: string
          instanceId: string
          introspectionEndpoint: string
          issuer: string
          jwksTimeout: string
          jwksUri: string
          oauthControllerSettings:
            - clientId: string
              clientSecret: string
              oidcConfigs:
                - oidcEnable: string
                  profile: string
                  userinfo: string
              scopes:
                - string
          oauthProfileType: string
          oauthProvider: string
          oauthRespBufferSz: string
          orgId: string
          poolRef: string
          redirectUri: string
          serviceId: string
          serviceName: string
          tokenEndpoint: string
          userinfoEndpoint: string
    samls:
        - idps:
            - metaDataDownloadInterval: string
              metadata: string
              metadataUrl: string
              periodicDownload: string
          sps:
            - fqdn: string
              orgDisplayName: string
              orgName: string
              orgUrl: string
              samlEntityType: string
              spNodes:
                - entityId: string
                  name: string
                  signingSslKeyAndCertificateRef: string
                  singleSignonUrl: string
              techContactEmail: string
              techContactName: string
    tacacsPluses:
        - authorizationAttrs:
            - mandatory: string
              name: string
              value: string
          password: string
          port: string
          servers:
            - string
          service: string
    tenantRef: string
    type: string
    uuid: string
Copy

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

Type This property is required. string
Type of the auth profile. Enum options - AUTH_PROFILE_LDAP, AUTH_PROFILE_TACACS_PLUS, AUTH_PROFILE_SAML, AUTH_PROFILE_PINGACCESS, AUTH_PROFILE_JWT, AUTH_PROFILE_OAUTH. Allowed with any value in enterprise, enterprise with cloud services edition. Allowed in essentials (allowed values- auth_profile_ldap,auth_profile_tacacs_plus,auth_profile_saml,auth_profile_jwt,auth_profile_oauth), basic (allowed values- auth_profile_ldap,auth_profile_tacacs_plus,auth_profile_saml,auth_profile_jwt,auth_profile_oauth) edition.
AuthprofileId string
ConfigpbAttributes List<AuthprofileConfigpbAttribute>
Protobuf versioning for config pbs. Field introduced in 21.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
Description string
Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
Https List<AuthprofileHttp>
Http user authentication params. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
JwtProfileRef string
Jwtserverprofile to be used for authentication. It is a reference to an object of type jwtserverprofile. Field introduced in 20.1.3. Allowed with any value in enterprise, enterprise with cloud services edition.
Ldaps List<AuthprofileLdap>
Ldap server and directory settings. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
Markers List<AuthprofileMarker>
List of labels to be used for granular rbac. Field introduced in 20.1.6. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
Name string
Name of the auth profile. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
OauthProfiles List<AuthprofileOauthProfile>
Oauth profile - common endpoint information. Field introduced in 21.1.3. Allowed with any value in enterprise, enterprise with cloud services edition.
Samls List<AuthprofileSaml>
Saml settings. Field introduced in 17.2.3. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
TacacsPluses List<AuthprofileTacacsPlus>
Tacacs+ settings. Allowed with any value in enterprise, enterprise with cloud services edition.
TenantRef string
It is a reference to an object of type tenant. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
Uuid string
Uuid of the auth profile. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
Type This property is required. string
Type of the auth profile. Enum options - AUTH_PROFILE_LDAP, AUTH_PROFILE_TACACS_PLUS, AUTH_PROFILE_SAML, AUTH_PROFILE_PINGACCESS, AUTH_PROFILE_JWT, AUTH_PROFILE_OAUTH. Allowed with any value in enterprise, enterprise with cloud services edition. Allowed in essentials (allowed values- auth_profile_ldap,auth_profile_tacacs_plus,auth_profile_saml,auth_profile_jwt,auth_profile_oauth), basic (allowed values- auth_profile_ldap,auth_profile_tacacs_plus,auth_profile_saml,auth_profile_jwt,auth_profile_oauth) edition.
AuthprofileId string
ConfigpbAttributes []AuthprofileConfigpbAttributeArgs
Protobuf versioning for config pbs. Field introduced in 21.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
Description string
Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
Https []AuthprofileHttpArgs
Http user authentication params. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
JwtProfileRef string
Jwtserverprofile to be used for authentication. It is a reference to an object of type jwtserverprofile. Field introduced in 20.1.3. Allowed with any value in enterprise, enterprise with cloud services edition.
Ldaps []AuthprofileLdapArgs
Ldap server and directory settings. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
Markers []AuthprofileMarkerArgs
List of labels to be used for granular rbac. Field introduced in 20.1.6. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
Name string
Name of the auth profile. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
OauthProfiles []AuthprofileOauthProfileArgs
Oauth profile - common endpoint information. Field introduced in 21.1.3. Allowed with any value in enterprise, enterprise with cloud services edition.
Samls []AuthprofileSamlArgs
Saml settings. Field introduced in 17.2.3. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
TacacsPluses []AuthprofileTacacsPlusArgs
Tacacs+ settings. Allowed with any value in enterprise, enterprise with cloud services edition.
TenantRef string
It is a reference to an object of type tenant. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
Uuid string
Uuid of the auth profile. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
type This property is required. String
Type of the auth profile. Enum options - AUTH_PROFILE_LDAP, AUTH_PROFILE_TACACS_PLUS, AUTH_PROFILE_SAML, AUTH_PROFILE_PINGACCESS, AUTH_PROFILE_JWT, AUTH_PROFILE_OAUTH. Allowed with any value in enterprise, enterprise with cloud services edition. Allowed in essentials (allowed values- auth_profile_ldap,auth_profile_tacacs_plus,auth_profile_saml,auth_profile_jwt,auth_profile_oauth), basic (allowed values- auth_profile_ldap,auth_profile_tacacs_plus,auth_profile_saml,auth_profile_jwt,auth_profile_oauth) edition.
authprofileId String
configpbAttributes List<AuthprofileConfigpbAttribute>
Protobuf versioning for config pbs. Field introduced in 21.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
description String
Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
https List<AuthprofileHttp>
Http user authentication params. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
jwtProfileRef String
Jwtserverprofile to be used for authentication. It is a reference to an object of type jwtserverprofile. Field introduced in 20.1.3. Allowed with any value in enterprise, enterprise with cloud services edition.
ldaps List<AuthprofileLdap>
Ldap server and directory settings. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
markers List<AuthprofileMarker>
List of labels to be used for granular rbac. Field introduced in 20.1.6. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
name String
Name of the auth profile. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
oauthProfiles List<AuthprofileOauthProfile>
Oauth profile - common endpoint information. Field introduced in 21.1.3. Allowed with any value in enterprise, enterprise with cloud services edition.
samls List<AuthprofileSaml>
Saml settings. Field introduced in 17.2.3. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
tacacsPluses List<AuthprofileTacacsPlus>
Tacacs+ settings. Allowed with any value in enterprise, enterprise with cloud services edition.
tenantRef String
It is a reference to an object of type tenant. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
uuid String
Uuid of the auth profile. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
type This property is required. string
Type of the auth profile. Enum options - AUTH_PROFILE_LDAP, AUTH_PROFILE_TACACS_PLUS, AUTH_PROFILE_SAML, AUTH_PROFILE_PINGACCESS, AUTH_PROFILE_JWT, AUTH_PROFILE_OAUTH. Allowed with any value in enterprise, enterprise with cloud services edition. Allowed in essentials (allowed values- auth_profile_ldap,auth_profile_tacacs_plus,auth_profile_saml,auth_profile_jwt,auth_profile_oauth), basic (allowed values- auth_profile_ldap,auth_profile_tacacs_plus,auth_profile_saml,auth_profile_jwt,auth_profile_oauth) edition.
authprofileId string
configpbAttributes AuthprofileConfigpbAttribute[]
Protobuf versioning for config pbs. Field introduced in 21.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
description string
Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
https AuthprofileHttp[]
Http user authentication params. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
jwtProfileRef string
Jwtserverprofile to be used for authentication. It is a reference to an object of type jwtserverprofile. Field introduced in 20.1.3. Allowed with any value in enterprise, enterprise with cloud services edition.
ldaps AuthprofileLdap[]
Ldap server and directory settings. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
markers AuthprofileMarker[]
List of labels to be used for granular rbac. Field introduced in 20.1.6. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
name string
Name of the auth profile. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
oauthProfiles AuthprofileOauthProfile[]
Oauth profile - common endpoint information. Field introduced in 21.1.3. Allowed with any value in enterprise, enterprise with cloud services edition.
samls AuthprofileSaml[]
Saml settings. Field introduced in 17.2.3. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
tacacsPluses AuthprofileTacacsPlus[]
Tacacs+ settings. Allowed with any value in enterprise, enterprise with cloud services edition.
tenantRef string
It is a reference to an object of type tenant. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
uuid string
Uuid of the auth profile. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
type This property is required. str
Type of the auth profile. Enum options - AUTH_PROFILE_LDAP, AUTH_PROFILE_TACACS_PLUS, AUTH_PROFILE_SAML, AUTH_PROFILE_PINGACCESS, AUTH_PROFILE_JWT, AUTH_PROFILE_OAUTH. Allowed with any value in enterprise, enterprise with cloud services edition. Allowed in essentials (allowed values- auth_profile_ldap,auth_profile_tacacs_plus,auth_profile_saml,auth_profile_jwt,auth_profile_oauth), basic (allowed values- auth_profile_ldap,auth_profile_tacacs_plus,auth_profile_saml,auth_profile_jwt,auth_profile_oauth) edition.
authprofile_id str
configpb_attributes Sequence[AuthprofileConfigpbAttributeArgs]
Protobuf versioning for config pbs. Field introduced in 21.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
description str
Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
https Sequence[AuthprofileHttpArgs]
Http user authentication params. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
jwt_profile_ref str
Jwtserverprofile to be used for authentication. It is a reference to an object of type jwtserverprofile. Field introduced in 20.1.3. Allowed with any value in enterprise, enterprise with cloud services edition.
ldaps Sequence[AuthprofileLdapArgs]
Ldap server and directory settings. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
markers Sequence[AuthprofileMarkerArgs]
List of labels to be used for granular rbac. Field introduced in 20.1.6. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
name str
Name of the auth profile. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
oauth_profiles Sequence[AuthprofileOauthProfileArgs]
Oauth profile - common endpoint information. Field introduced in 21.1.3. Allowed with any value in enterprise, enterprise with cloud services edition.
samls Sequence[AuthprofileSamlArgs]
Saml settings. Field introduced in 17.2.3. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
tacacs_pluses Sequence[AuthprofileTacacsPlusArgs]
Tacacs+ settings. Allowed with any value in enterprise, enterprise with cloud services edition.
tenant_ref str
It is a reference to an object of type tenant. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
uuid str
Uuid of the auth profile. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
type This property is required. String
Type of the auth profile. Enum options - AUTH_PROFILE_LDAP, AUTH_PROFILE_TACACS_PLUS, AUTH_PROFILE_SAML, AUTH_PROFILE_PINGACCESS, AUTH_PROFILE_JWT, AUTH_PROFILE_OAUTH. Allowed with any value in enterprise, enterprise with cloud services edition. Allowed in essentials (allowed values- auth_profile_ldap,auth_profile_tacacs_plus,auth_profile_saml,auth_profile_jwt,auth_profile_oauth), basic (allowed values- auth_profile_ldap,auth_profile_tacacs_plus,auth_profile_saml,auth_profile_jwt,auth_profile_oauth) edition.
authprofileId String
configpbAttributes List<Property Map>
Protobuf versioning for config pbs. Field introduced in 21.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
description String
Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
https List<Property Map>
Http user authentication params. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
jwtProfileRef String
Jwtserverprofile to be used for authentication. It is a reference to an object of type jwtserverprofile. Field introduced in 20.1.3. Allowed with any value in enterprise, enterprise with cloud services edition.
ldaps List<Property Map>
Ldap server and directory settings. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
markers List<Property Map>
List of labels to be used for granular rbac. Field introduced in 20.1.6. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
name String
Name of the auth profile. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
oauthProfiles List<Property Map>
Oauth profile - common endpoint information. Field introduced in 21.1.3. Allowed with any value in enterprise, enterprise with cloud services edition.
samls List<Property Map>
Saml settings. Field introduced in 17.2.3. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
tacacsPluses List<Property Map>
Tacacs+ settings. Allowed with any value in enterprise, enterprise with cloud services edition.
tenantRef String
It is a reference to an object of type tenant. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
uuid String
Uuid of the auth profile. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.

Outputs

All input properties are implicitly available as output properties. Additionally, the Authprofile 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 Authprofile Resource

Get an existing Authprofile 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?: AuthprofileState, opts?: CustomResourceOptions): Authprofile
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        authprofile_id: Optional[str] = None,
        configpb_attributes: Optional[Sequence[AuthprofileConfigpbAttributeArgs]] = None,
        description: Optional[str] = None,
        https: Optional[Sequence[AuthprofileHttpArgs]] = None,
        jwt_profile_ref: Optional[str] = None,
        ldaps: Optional[Sequence[AuthprofileLdapArgs]] = None,
        markers: Optional[Sequence[AuthprofileMarkerArgs]] = None,
        name: Optional[str] = None,
        oauth_profiles: Optional[Sequence[AuthprofileOauthProfileArgs]] = None,
        samls: Optional[Sequence[AuthprofileSamlArgs]] = None,
        tacacs_pluses: Optional[Sequence[AuthprofileTacacsPlusArgs]] = None,
        tenant_ref: Optional[str] = None,
        type: Optional[str] = None,
        uuid: Optional[str] = None) -> Authprofile
func GetAuthprofile(ctx *Context, name string, id IDInput, state *AuthprofileState, opts ...ResourceOption) (*Authprofile, error)
public static Authprofile Get(string name, Input<string> id, AuthprofileState? state, CustomResourceOptions? opts = null)
public static Authprofile get(String name, Output<String> id, AuthprofileState state, CustomResourceOptions options)
resources:  _:    type: avi:Authprofile    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:
AuthprofileId string
ConfigpbAttributes List<AuthprofileConfigpbAttribute>
Protobuf versioning for config pbs. Field introduced in 21.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
Description string
Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
Https List<AuthprofileHttp>
Http user authentication params. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
JwtProfileRef string
Jwtserverprofile to be used for authentication. It is a reference to an object of type jwtserverprofile. Field introduced in 20.1.3. Allowed with any value in enterprise, enterprise with cloud services edition.
Ldaps List<AuthprofileLdap>
Ldap server and directory settings. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
Markers List<AuthprofileMarker>
List of labels to be used for granular rbac. Field introduced in 20.1.6. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
Name string
Name of the auth profile. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
OauthProfiles List<AuthprofileOauthProfile>
Oauth profile - common endpoint information. Field introduced in 21.1.3. Allowed with any value in enterprise, enterprise with cloud services edition.
Samls List<AuthprofileSaml>
Saml settings. Field introduced in 17.2.3. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
TacacsPluses List<AuthprofileTacacsPlus>
Tacacs+ settings. Allowed with any value in enterprise, enterprise with cloud services edition.
TenantRef string
It is a reference to an object of type tenant. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
Type string
Type of the auth profile. Enum options - AUTH_PROFILE_LDAP, AUTH_PROFILE_TACACS_PLUS, AUTH_PROFILE_SAML, AUTH_PROFILE_PINGACCESS, AUTH_PROFILE_JWT, AUTH_PROFILE_OAUTH. Allowed with any value in enterprise, enterprise with cloud services edition. Allowed in essentials (allowed values- auth_profile_ldap,auth_profile_tacacs_plus,auth_profile_saml,auth_profile_jwt,auth_profile_oauth), basic (allowed values- auth_profile_ldap,auth_profile_tacacs_plus,auth_profile_saml,auth_profile_jwt,auth_profile_oauth) edition.
Uuid string
Uuid of the auth profile. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
AuthprofileId string
ConfigpbAttributes []AuthprofileConfigpbAttributeArgs
Protobuf versioning for config pbs. Field introduced in 21.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
Description string
Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
Https []AuthprofileHttpArgs
Http user authentication params. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
JwtProfileRef string
Jwtserverprofile to be used for authentication. It is a reference to an object of type jwtserverprofile. Field introduced in 20.1.3. Allowed with any value in enterprise, enterprise with cloud services edition.
Ldaps []AuthprofileLdapArgs
Ldap server and directory settings. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
Markers []AuthprofileMarkerArgs
List of labels to be used for granular rbac. Field introduced in 20.1.6. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
Name string
Name of the auth profile. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
OauthProfiles []AuthprofileOauthProfileArgs
Oauth profile - common endpoint information. Field introduced in 21.1.3. Allowed with any value in enterprise, enterprise with cloud services edition.
Samls []AuthprofileSamlArgs
Saml settings. Field introduced in 17.2.3. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
TacacsPluses []AuthprofileTacacsPlusArgs
Tacacs+ settings. Allowed with any value in enterprise, enterprise with cloud services edition.
TenantRef string
It is a reference to an object of type tenant. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
Type string
Type of the auth profile. Enum options - AUTH_PROFILE_LDAP, AUTH_PROFILE_TACACS_PLUS, AUTH_PROFILE_SAML, AUTH_PROFILE_PINGACCESS, AUTH_PROFILE_JWT, AUTH_PROFILE_OAUTH. Allowed with any value in enterprise, enterprise with cloud services edition. Allowed in essentials (allowed values- auth_profile_ldap,auth_profile_tacacs_plus,auth_profile_saml,auth_profile_jwt,auth_profile_oauth), basic (allowed values- auth_profile_ldap,auth_profile_tacacs_plus,auth_profile_saml,auth_profile_jwt,auth_profile_oauth) edition.
Uuid string
Uuid of the auth profile. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
authprofileId String
configpbAttributes List<AuthprofileConfigpbAttribute>
Protobuf versioning for config pbs. Field introduced in 21.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
description String
Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
https List<AuthprofileHttp>
Http user authentication params. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
jwtProfileRef String
Jwtserverprofile to be used for authentication. It is a reference to an object of type jwtserverprofile. Field introduced in 20.1.3. Allowed with any value in enterprise, enterprise with cloud services edition.
ldaps List<AuthprofileLdap>
Ldap server and directory settings. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
markers List<AuthprofileMarker>
List of labels to be used for granular rbac. Field introduced in 20.1.6. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
name String
Name of the auth profile. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
oauthProfiles List<AuthprofileOauthProfile>
Oauth profile - common endpoint information. Field introduced in 21.1.3. Allowed with any value in enterprise, enterprise with cloud services edition.
samls List<AuthprofileSaml>
Saml settings. Field introduced in 17.2.3. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
tacacsPluses List<AuthprofileTacacsPlus>
Tacacs+ settings. Allowed with any value in enterprise, enterprise with cloud services edition.
tenantRef String
It is a reference to an object of type tenant. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
type String
Type of the auth profile. Enum options - AUTH_PROFILE_LDAP, AUTH_PROFILE_TACACS_PLUS, AUTH_PROFILE_SAML, AUTH_PROFILE_PINGACCESS, AUTH_PROFILE_JWT, AUTH_PROFILE_OAUTH. Allowed with any value in enterprise, enterprise with cloud services edition. Allowed in essentials (allowed values- auth_profile_ldap,auth_profile_tacacs_plus,auth_profile_saml,auth_profile_jwt,auth_profile_oauth), basic (allowed values- auth_profile_ldap,auth_profile_tacacs_plus,auth_profile_saml,auth_profile_jwt,auth_profile_oauth) edition.
uuid String
Uuid of the auth profile. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
authprofileId string
configpbAttributes AuthprofileConfigpbAttribute[]
Protobuf versioning for config pbs. Field introduced in 21.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
description string
Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
https AuthprofileHttp[]
Http user authentication params. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
jwtProfileRef string
Jwtserverprofile to be used for authentication. It is a reference to an object of type jwtserverprofile. Field introduced in 20.1.3. Allowed with any value in enterprise, enterprise with cloud services edition.
ldaps AuthprofileLdap[]
Ldap server and directory settings. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
markers AuthprofileMarker[]
List of labels to be used for granular rbac. Field introduced in 20.1.6. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
name string
Name of the auth profile. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
oauthProfiles AuthprofileOauthProfile[]
Oauth profile - common endpoint information. Field introduced in 21.1.3. Allowed with any value in enterprise, enterprise with cloud services edition.
samls AuthprofileSaml[]
Saml settings. Field introduced in 17.2.3. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
tacacsPluses AuthprofileTacacsPlus[]
Tacacs+ settings. Allowed with any value in enterprise, enterprise with cloud services edition.
tenantRef string
It is a reference to an object of type tenant. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
type string
Type of the auth profile. Enum options - AUTH_PROFILE_LDAP, AUTH_PROFILE_TACACS_PLUS, AUTH_PROFILE_SAML, AUTH_PROFILE_PINGACCESS, AUTH_PROFILE_JWT, AUTH_PROFILE_OAUTH. Allowed with any value in enterprise, enterprise with cloud services edition. Allowed in essentials (allowed values- auth_profile_ldap,auth_profile_tacacs_plus,auth_profile_saml,auth_profile_jwt,auth_profile_oauth), basic (allowed values- auth_profile_ldap,auth_profile_tacacs_plus,auth_profile_saml,auth_profile_jwt,auth_profile_oauth) edition.
uuid string
Uuid of the auth profile. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
authprofile_id str
configpb_attributes Sequence[AuthprofileConfigpbAttributeArgs]
Protobuf versioning for config pbs. Field introduced in 21.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
description str
Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
https Sequence[AuthprofileHttpArgs]
Http user authentication params. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
jwt_profile_ref str
Jwtserverprofile to be used for authentication. It is a reference to an object of type jwtserverprofile. Field introduced in 20.1.3. Allowed with any value in enterprise, enterprise with cloud services edition.
ldaps Sequence[AuthprofileLdapArgs]
Ldap server and directory settings. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
markers Sequence[AuthprofileMarkerArgs]
List of labels to be used for granular rbac. Field introduced in 20.1.6. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
name str
Name of the auth profile. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
oauth_profiles Sequence[AuthprofileOauthProfileArgs]
Oauth profile - common endpoint information. Field introduced in 21.1.3. Allowed with any value in enterprise, enterprise with cloud services edition.
samls Sequence[AuthprofileSamlArgs]
Saml settings. Field introduced in 17.2.3. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
tacacs_pluses Sequence[AuthprofileTacacsPlusArgs]
Tacacs+ settings. Allowed with any value in enterprise, enterprise with cloud services edition.
tenant_ref str
It is a reference to an object of type tenant. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
type str
Type of the auth profile. Enum options - AUTH_PROFILE_LDAP, AUTH_PROFILE_TACACS_PLUS, AUTH_PROFILE_SAML, AUTH_PROFILE_PINGACCESS, AUTH_PROFILE_JWT, AUTH_PROFILE_OAUTH. Allowed with any value in enterprise, enterprise with cloud services edition. Allowed in essentials (allowed values- auth_profile_ldap,auth_profile_tacacs_plus,auth_profile_saml,auth_profile_jwt,auth_profile_oauth), basic (allowed values- auth_profile_ldap,auth_profile_tacacs_plus,auth_profile_saml,auth_profile_jwt,auth_profile_oauth) edition.
uuid str
Uuid of the auth profile. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
authprofileId String
configpbAttributes List<Property Map>
Protobuf versioning for config pbs. Field introduced in 21.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
description String
Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
https List<Property Map>
Http user authentication params. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
jwtProfileRef String
Jwtserverprofile to be used for authentication. It is a reference to an object of type jwtserverprofile. Field introduced in 20.1.3. Allowed with any value in enterprise, enterprise with cloud services edition.
ldaps List<Property Map>
Ldap server and directory settings. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
markers List<Property Map>
List of labels to be used for granular rbac. Field introduced in 20.1.6. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
name String
Name of the auth profile. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
oauthProfiles List<Property Map>
Oauth profile - common endpoint information. Field introduced in 21.1.3. Allowed with any value in enterprise, enterprise with cloud services edition.
samls List<Property Map>
Saml settings. Field introduced in 17.2.3. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
tacacsPluses List<Property Map>
Tacacs+ settings. Allowed with any value in enterprise, enterprise with cloud services edition.
tenantRef String
It is a reference to an object of type tenant. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
type String
Type of the auth profile. Enum options - AUTH_PROFILE_LDAP, AUTH_PROFILE_TACACS_PLUS, AUTH_PROFILE_SAML, AUTH_PROFILE_PINGACCESS, AUTH_PROFILE_JWT, AUTH_PROFILE_OAUTH. Allowed with any value in enterprise, enterprise with cloud services edition. Allowed in essentials (allowed values- auth_profile_ldap,auth_profile_tacacs_plus,auth_profile_saml,auth_profile_jwt,auth_profile_oauth), basic (allowed values- auth_profile_ldap,auth_profile_tacacs_plus,auth_profile_saml,auth_profile_jwt,auth_profile_oauth) edition.
uuid String
Uuid of the auth profile. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.

Supporting Types

AuthprofileConfigpbAttribute
, AuthprofileConfigpbAttributeArgs

Version string
Version string
version String
version string
version String

AuthprofileHttp
, AuthprofileHttpArgs

AuthprofileLdap
, AuthprofileLdapArgs

AuthprofileLdapSetting
, AuthprofileLdapSettingArgs

AdminBindDn This property is required. string
Password This property is required. string
UserIdAttribute This property is required. string
GroupFilter string
GroupMemberAttribute string
GroupMemberIsFullDn string
GroupSearchDn string
GroupSearchScope string
IgnoreReferrals string
UserAttributes List<string>
UserSearchDn string
UserSearchScope string
AdminBindDn This property is required. string
Password This property is required. string
UserIdAttribute This property is required. string
GroupFilter string
GroupMemberAttribute string
GroupMemberIsFullDn string
GroupSearchDn string
GroupSearchScope string
IgnoreReferrals string
UserAttributes []string
UserSearchDn string
UserSearchScope string
adminBindDn This property is required. String
password This property is required. String
userIdAttribute This property is required. String
groupFilter String
groupMemberAttribute String
groupMemberIsFullDn String
groupSearchDn String
groupSearchScope String
ignoreReferrals String
userAttributes List<String>
userSearchDn String
userSearchScope String
adminBindDn This property is required. string
password This property is required. string
userIdAttribute This property is required. string
groupFilter string
groupMemberAttribute string
groupMemberIsFullDn string
groupSearchDn string
groupSearchScope string
ignoreReferrals string
userAttributes string[]
userSearchDn string
userSearchScope string
admin_bind_dn This property is required. str
password This property is required. str
user_id_attribute This property is required. str
group_filter str
group_member_attribute str
group_member_is_full_dn str
group_search_dn str
group_search_scope str
ignore_referrals str
user_attributes Sequence[str]
user_search_dn str
user_search_scope str
adminBindDn This property is required. String
password This property is required. String
userIdAttribute This property is required. String
groupFilter String
groupMemberAttribute String
groupMemberIsFullDn String
groupSearchDn String
groupSearchScope String
ignoreReferrals String
userAttributes List<String>
userSearchDn String
userSearchScope String

AuthprofileLdapUserBind
, AuthprofileLdapUserBindArgs

DnTemplate This property is required. string
UserIdAttribute This property is required. string
Token string
UserAttributes List<string>
DnTemplate This property is required. string
UserIdAttribute This property is required. string
Token string
UserAttributes []string
dnTemplate This property is required. String
userIdAttribute This property is required. String
token String
userAttributes List<String>
dnTemplate This property is required. string
userIdAttribute This property is required. string
token string
userAttributes string[]
dn_template This property is required. str
user_id_attribute This property is required. str
token str
user_attributes Sequence[str]
dnTemplate This property is required. String
userIdAttribute This property is required. String
token String
userAttributes List<String>

AuthprofileMarker
, AuthprofileMarkerArgs

Key This property is required. string
Values List<string>
Key This property is required. string
Values []string
key This property is required. String
values List<String>
key This property is required. string
values string[]
key This property is required. str
values Sequence[str]
key This property is required. String
values List<String>

AuthprofileOauthProfile
, AuthprofileOauthProfileArgs

AuthprofileOauthProfileOauthControllerSetting
, AuthprofileOauthProfileOauthControllerSettingArgs

clientId This property is required. String
clientSecret String
oidcConfigs List<Property Map>
scopes List<String>

AuthprofileOauthProfileOauthControllerSettingOidcConfig
, AuthprofileOauthProfileOauthControllerSettingOidcConfigArgs

OidcEnable string
Profile string
Userinfo string
OidcEnable string
Profile string
Userinfo string
oidcEnable String
profile String
userinfo String
oidcEnable string
profile string
userinfo string
oidcEnable String
profile String
userinfo String

AuthprofileSaml
, AuthprofileSamlArgs

Idps This property is required. List<AuthprofileSamlIdp>
Sps This property is required. List<AuthprofileSamlSp>
Idps This property is required. []AuthprofileSamlIdp
Sps This property is required. []AuthprofileSamlSp
idps This property is required. List<AuthprofileSamlIdp>
sps This property is required. List<AuthprofileSamlSp>
idps This property is required. AuthprofileSamlIdp[]
sps This property is required. AuthprofileSamlSp[]
idps This property is required. Sequence[AuthprofileSamlIdp]
sps This property is required. Sequence[AuthprofileSamlSp]
idps This property is required. List<Property Map>
sps This property is required. List<Property Map>

AuthprofileSamlIdp
, AuthprofileSamlIdpArgs

AuthprofileSamlSp
, AuthprofileSamlSpArgs

AuthprofileSamlSpSpNode
, AuthprofileSamlSpSpNodeArgs

Name This property is required. string
Name of the auth profile. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
EntityId string
SigningSslKeyAndCertificateRef string
SingleSignonUrl string
Name This property is required. string
Name of the auth profile. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
EntityId string
SigningSslKeyAndCertificateRef string
SingleSignonUrl string
name This property is required. String
Name of the auth profile. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
entityId String
signingSslKeyAndCertificateRef String
singleSignonUrl String
name This property is required. string
Name of the auth profile. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
entityId string
signingSslKeyAndCertificateRef string
singleSignonUrl string
name This property is required. str
Name of the auth profile. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
entity_id str
signing_ssl_key_and_certificate_ref str
single_signon_url str
name This property is required. String
Name of the auth profile. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
entityId String
signingSslKeyAndCertificateRef String
singleSignonUrl String

AuthprofileTacacsPlus
, AuthprofileTacacsPlusArgs

Servers This property is required. List<string>
AuthorizationAttrs List<AuthprofileTacacsPlusAuthorizationAttr>
Password string
Port string
Service string
Servers This property is required. []string
AuthorizationAttrs []AuthprofileTacacsPlusAuthorizationAttr
Password string
Port string
Service string
servers This property is required. List<String>
authorizationAttrs List<AuthprofileTacacsPlusAuthorizationAttr>
password String
port String
service String
servers This property is required. string[]
authorizationAttrs AuthprofileTacacsPlusAuthorizationAttr[]
password string
port string
service string
servers This property is required. List<String>
authorizationAttrs List<Property Map>
password String
port String
service String

AuthprofileTacacsPlusAuthorizationAttr
, AuthprofileTacacsPlusAuthorizationAttrArgs

Mandatory string
Name string
Name of the auth profile. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
Value string
Mandatory string
Name string
Name of the auth profile. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
Value string
mandatory String
name String
Name of the auth profile. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
value String
mandatory string
name string
Name of the auth profile. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
value string
mandatory str
name str
Name of the auth profile. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
value str
mandatory String
name String
Name of the auth profile. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
value String

Package Details

Repository
avi vmware/terraform-provider-avi
License
Notes
This Pulumi package is based on the avi Terraform Provider.