avi.getAuthprofile

Explore with Pulumi AI

avi 31.1.1 published on Monday, Apr 14, 2025 by vmware

<!–

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

–>

layout: “avi”

page_title: “AVI: avi.Authprofile” sidebar_current: “docs-avi-datasource-authprofile” description: |- Get information of Avi AuthProfile.

avi.Authprofile

This data source is used to to get avi.Authprofile objects.

Example Usage

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

const fooAuthprofile = avi.getAuthprofile({
    name: "foo",
    uuid: "authprofile-f9cf6b3e-a411-436f-95e2-2982ba2b217b",
});

import pulumi
import pulumi_avi as avi

foo_authprofile = avi.get_authprofile(name="foo",
    uuid="authprofile-f9cf6b3e-a411-436f-95e2-2982ba2b217b")

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.LookupAuthprofile(ctx, &avi.LookupAuthprofileArgs{
			Name: pulumi.StringRef("foo"),
			Uuid: pulumi.StringRef("authprofile-f9cf6b3e-a411-436f-95e2-2982ba2b217b"),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Avi = Pulumi.Avi;

return await Deployment.RunAsync(() => 
{
    var fooAuthprofile = Avi.GetAuthprofile.Invoke(new()
    {
        Name = "foo",
        Uuid = "authprofile-f9cf6b3e-a411-436f-95e2-2982ba2b217b",
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.avi.AviFunctions;
import com.pulumi.avi.inputs.GetAuthprofileArgs;
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) {
        final var fooAuthprofile = AviFunctions.getAuthprofile(GetAuthprofileArgs.builder()
            .name("foo")
            .uuid("authprofile-f9cf6b3e-a411-436f-95e2-2982ba2b217b")
            .build());

    }
}

variables:
  fooAuthprofile:
    fn::invoke:
      function: avi:getAuthprofile
      arguments:
        name: foo
        uuid: authprofile-f9cf6b3e-a411-436f-95e2-2982ba2b217b

Using getAuthprofile

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getAuthprofile(args: GetAuthprofileArgs, opts?: InvokeOptions): Promise<GetAuthprofileResult>
function getAuthprofileOutput(args: GetAuthprofileOutputArgs, opts?: InvokeOptions): Output<GetAuthprofileResult>

def get_authprofile(id: Optional[str] = None,
                    name: Optional[str] = None,
                    tenant_ref: Optional[str] = None,
                    uuid: Optional[str] = None,
                    opts: Optional[InvokeOptions] = None) -> GetAuthprofileResult
def get_authprofile_output(id: Optional[pulumi.Input[str]] = None,
                    name: Optional[pulumi.Input[str]] = None,
                    tenant_ref: Optional[pulumi.Input[str]] = None,
                    uuid: Optional[pulumi.Input[str]] = None,
                    opts: Optional[InvokeOptions] = None) -> Output[GetAuthprofileResult]

func LookupAuthprofile(ctx *Context, args *LookupAuthprofileArgs, opts ...InvokeOption) (*LookupAuthprofileResult, error)
func LookupAuthprofileOutput(ctx *Context, args *LookupAuthprofileOutputArgs, opts ...InvokeOption) LookupAuthprofileResultOutput

> Note: This function is named LookupAuthprofile in the Go SDK.

public static class GetAuthprofile 
{
    public static Task<GetAuthprofileResult> InvokeAsync(GetAuthprofileArgs args, InvokeOptions? opts = null)
    public static Output<GetAuthprofileResult> Invoke(GetAuthprofileInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetAuthprofileResult> getAuthprofile(GetAuthprofileArgs args, InvokeOptions options)
public static Output<GetAuthprofileResult> getAuthprofile(GetAuthprofileArgs args, InvokeOptions options)

fn::invoke:
  function: avi:index/getAuthprofile:getAuthprofile
  arguments:
    # arguments dictionary

The following arguments are supported:

Id string
Name string: Search AuthProfile by name.
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: Search AuthProfile by uuid.

Id string
Name string: Search AuthProfile by name.
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: Search AuthProfile by uuid.

id String
name String: Search AuthProfile by name.
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: Search AuthProfile by uuid.

id string
name string: Search AuthProfile by name.
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: Search AuthProfile by uuid.

id str
name str: Search AuthProfile by name.
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: Search AuthProfile by uuid.

id String
name String: Search AuthProfile by name.
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: Search AuthProfile by uuid.

getAuthprofile Result

The following output properties are available:

ConfigpbAttributes List<GetAuthprofileConfigpbAttribute>: 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<GetAuthprofileHttp>: Http user authentication params. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
Id string
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<GetAuthprofileLdap>: Ldap server and directory settings. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
Markers List<GetAuthprofileMarker>: 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<GetAuthprofileOauthProfile>: Oauth profile - common endpoint information. Field introduced in 21.1.3. Allowed with any value in enterprise, enterprise with cloud services edition.
Samls List<GetAuthprofileSaml>: Saml settings. Field introduced in 17.2.3. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
TacacsPluses List<GetAuthprofileTacacsPlus>: 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.

ConfigpbAttributes []GetAuthprofileConfigpbAttribute: 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 []GetAuthprofileHttp: Http user authentication params. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
Id string
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 []GetAuthprofileLdap: Ldap server and directory settings. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
Markers []GetAuthprofileMarker: 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 []GetAuthprofileOauthProfile: Oauth profile - common endpoint information. Field introduced in 21.1.3. Allowed with any value in enterprise, enterprise with cloud services edition.
Samls []GetAuthprofileSaml: Saml settings. Field introduced in 17.2.3. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
TacacsPluses []GetAuthprofileTacacsPlus: 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.

configpbAttributes List<GetAuthprofileConfigpbAttribute>: 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<GetAuthprofileHttp>: Http user authentication params. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
id String
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<GetAuthprofileLdap>: Ldap server and directory settings. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
markers List<GetAuthprofileMarker>: 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<GetAuthprofileOauthProfile>: Oauth profile - common endpoint information. Field introduced in 21.1.3. Allowed with any value in enterprise, enterprise with cloud services edition.
samls List<GetAuthprofileSaml>: Saml settings. Field introduced in 17.2.3. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
tacacsPluses List<GetAuthprofileTacacsPlus>: 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.

configpbAttributes GetAuthprofileConfigpbAttribute[]: 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 GetAuthprofileHttp[]: Http user authentication params. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
id string
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 GetAuthprofileLdap[]: Ldap server and directory settings. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
markers GetAuthprofileMarker[]: 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 GetAuthprofileOauthProfile[]: Oauth profile - common endpoint information. Field introduced in 21.1.3. Allowed with any value in enterprise, enterprise with cloud services edition.
samls GetAuthprofileSaml[]: Saml settings. Field introduced in 17.2.3. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
tacacsPluses GetAuthprofileTacacsPlus[]: 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.

configpb_attributes Sequence[GetAuthprofileConfigpbAttribute]: 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[GetAuthprofileHttp]: Http user authentication params. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
id str
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[GetAuthprofileLdap]: Ldap server and directory settings. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
markers Sequence[GetAuthprofileMarker]: 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[GetAuthprofileOauthProfile]: Oauth profile - common endpoint information. Field introduced in 21.1.3. Allowed with any value in enterprise, enterprise with cloud services edition.
samls Sequence[GetAuthprofileSaml]: Saml settings. Field introduced in 17.2.3. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
tacacs_pluses Sequence[GetAuthprofileTacacsPlus]: 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.

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.
id String
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.