Viewing docs for authentik 2025.12.1
published on Thursday, Feb 5, 2026 by goauthentik
published on Thursday, Feb 5, 2026 by goauthentik
Viewing docs for authentik 2025.12.1
published on Thursday, Feb 5, 2026 by goauthentik
published on Thursday, Feb 5, 2026 by goauthentik
Get users by pk or username
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as authentik from "@pulumi/authentik";
// To get the name of a user by username
const akadmin = authentik.getUser({
username: "akadmin",
});
import pulumi
import pulumi_authentik as authentik
# To get the name of a user by username
akadmin = authentik.get_user(username="akadmin")
package main
import (
"github.com/pulumi/pulumi-terraform-provider/sdks/go/authentik/v2025/authentik"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
// To get the name of a user by username
_, err := authentik.LookupUser(ctx, &authentik.LookupUserArgs{
Username: pulumi.StringRef("akadmin"),
}, nil)
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Authentik = Pulumi.Authentik;
return await Deployment.RunAsync(() =>
{
// To get the name of a user by username
var akadmin = Authentik.GetUser.Invoke(new()
{
Username = "akadmin",
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.authentik.AuthentikFunctions;
import com.pulumi.authentik.inputs.GetUserArgs;
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) {
// To get the name of a user by username
final var akadmin = AuthentikFunctions.getUser(GetUserArgs.builder()
.username("akadmin")
.build());
}
}
variables:
# To get the name of a user by username
akadmin:
fn::invoke:
function: authentik:getUser
arguments:
username: akadmin
Using getUser
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 getUser(args: GetUserArgs, opts?: InvokeOptions): Promise<GetUserResult>
function getUserOutput(args: GetUserOutputArgs, opts?: InvokeOptions): Output<GetUserResult>def get_user(id: Optional[str] = None,
pk: Optional[float] = None,
username: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetUserResult
def get_user_output(id: Optional[pulumi.Input[str]] = None,
pk: Optional[pulumi.Input[float]] = None,
username: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetUserResult]func LookupUser(ctx *Context, args *LookupUserArgs, opts ...InvokeOption) (*LookupUserResult, error)
func LookupUserOutput(ctx *Context, args *LookupUserOutputArgs, opts ...InvokeOption) LookupUserResultOutput> Note: This function is named LookupUser in the Go SDK.
public static class GetUser
{
public static Task<GetUserResult> InvokeAsync(GetUserArgs args, InvokeOptions? opts = null)
public static Output<GetUserResult> Invoke(GetUserInvokeArgs args, InvokeOptions? opts = null)
}public static CompletableFuture<GetUserResult> getUser(GetUserArgs args, InvokeOptions options)
public static Output<GetUserResult> getUser(GetUserArgs args, InvokeOptions options)
fn::invoke:
function: authentik:index/getUser:getUser
arguments:
# arguments dictionaryThe following arguments are supported:
getUser Result
The following output properties are available:
- Attributes string
- Generated.
- Avatar string
- Generated.
- Date
Joined string - Generated.
- Email string
- Generated.
- Groups List<string>
- Generated.
- Id string
- The ID of this resource.
- Is
Active bool - Generated.
- Is
Superuser bool - Generated.
- Last
Login string - Generated.
- Name string
- Generated.
- Path string
- Generated.
- Pk double
- Generated.
- Type string
- Generated.
- Uid string
- Generated.
- Username string
- Generated.
- Uuid string
- Generated.
- Attributes string
- Generated.
- Avatar string
- Generated.
- Date
Joined string - Generated.
- Email string
- Generated.
- Groups []string
- Generated.
- Id string
- The ID of this resource.
- Is
Active bool - Generated.
- Is
Superuser bool - Generated.
- Last
Login string - Generated.
- Name string
- Generated.
- Path string
- Generated.
- Pk float64
- Generated.
- Type string
- Generated.
- Uid string
- Generated.
- Username string
- Generated.
- Uuid string
- Generated.
- attributes String
- Generated.
- avatar String
- Generated.
- date
Joined String - Generated.
- email String
- Generated.
- groups List<String>
- Generated.
- id String
- The ID of this resource.
- is
Active Boolean - Generated.
- is
Superuser Boolean - Generated.
- last
Login String - Generated.
- name String
- Generated.
- path String
- Generated.
- pk Double
- Generated.
- type String
- Generated.
- uid String
- Generated.
- username String
- Generated.
- uuid String
- Generated.
- attributes string
- Generated.
- avatar string
- Generated.
- date
Joined string - Generated.
- email string
- Generated.
- groups string[]
- Generated.
- id string
- The ID of this resource.
- is
Active boolean - Generated.
- is
Superuser boolean - Generated.
- last
Login string - Generated.
- name string
- Generated.
- path string
- Generated.
- pk number
- Generated.
- type string
- Generated.
- uid string
- Generated.
- username string
- Generated.
- uuid string
- Generated.
- attributes str
- Generated.
- avatar str
- Generated.
- date_
joined str - Generated.
- email str
- Generated.
- groups Sequence[str]
- Generated.
- id str
- The ID of this resource.
- is_
active bool - Generated.
- is_
superuser bool - Generated.
- last_
login str - Generated.
- name str
- Generated.
- path str
- Generated.
- pk float
- Generated.
- type str
- Generated.
- uid str
- Generated.
- username str
- Generated.
- uuid str
- Generated.
- attributes String
- Generated.
- avatar String
- Generated.
- date
Joined String - Generated.
- email String
- Generated.
- groups List<String>
- Generated.
- id String
- The ID of this resource.
- is
Active Boolean - Generated.
- is
Superuser Boolean - Generated.
- last
Login String - Generated.
- name String
- Generated.
- path String
- Generated.
- pk Number
- Generated.
- type String
- Generated.
- uid String
- Generated.
- username String
- Generated.
- uuid String
- Generated.
Package Details
- Repository
- authentik goauthentik/terraform-provider-authentik
- License
- Notes
- This Pulumi package is based on the
authentikTerraform Provider.
Viewing docs for authentik 2025.12.1
published on Thursday, Feb 5, 2026 by goauthentik
published on Thursday, Feb 5, 2026 by goauthentik
