Ready to level-up your engineering skills? Join a Pulumi Workshop. Register Now

getUser

This data source can be used to fetch properties of a user within Keycloak.

Using getUser

function getUser(args: GetUserArgs, opts?: InvokeOptions): Promise<GetUserResult>
def get_user(realm_id: Optional[str] = None, username: Optional[str] = None, opts: Optional[InvokeOptions] = None) -> GetUserResult
func LookupUser(ctx *Context, args *LookupUserArgs, opts ...InvokeOption) (*LookupUserResult, error)

Note: This function is named LookupUser in the Go SDK.

public static class GetUser {
    public static Task<GetUserResult> InvokeAsync(GetUserArgs args, InvokeOptions? opts = null)
}

The following arguments are supported:

RealmId string

The realm this user belongs to.

Username string

The unique username of this user.

RealmId string

The realm this user belongs to.

Username string

The unique username of this user.

realmId string

The realm this user belongs to.

username string

The unique username of this user.

realm_id str

The realm this user belongs to.

username str

The unique username of this user.

getUser Result

The following output properties are available:

Attributes Dictionary<string, object>

(Computed) A map representing attributes for the user

Email string

(Computed) The user’s email.

EmailVerified bool

(Computed) Whether the email address was validated or not. Default to false.

Enabled bool

(Computed) When false, this user cannot log in. Defaults to true.

FederatedIdentities List<string>

(Computed) The user’s federated identities, if applicable. This block has the following schema:

FirstName string

(Computed) The user’s first name.

Id string

The provider-assigned unique ID for this managed resource.

LastName string

(Computed) The user’s last name.

RealmId string
Username string
Attributes map[string]interface{}

(Computed) A map representing attributes for the user

Email string

(Computed) The user’s email.

EmailVerified bool

(Computed) Whether the email address was validated or not. Default to false.

Enabled bool

(Computed) When false, this user cannot log in. Defaults to true.

FederatedIdentities []string

(Computed) The user’s federated identities, if applicable. This block has the following schema:

FirstName string

(Computed) The user’s first name.

Id string

The provider-assigned unique ID for this managed resource.

LastName string

(Computed) The user’s last name.

RealmId string
Username string
attributes {[key: string]: any}

(Computed) A map representing attributes for the user

email string

(Computed) The user’s email.

emailVerified boolean

(Computed) Whether the email address was validated or not. Default to false.

enabled boolean

(Computed) When false, this user cannot log in. Defaults to true.

federatedIdentities string[]

(Computed) The user’s federated identities, if applicable. This block has the following schema:

firstName string

(Computed) The user’s first name.

id string

The provider-assigned unique ID for this managed resource.

lastName string

(Computed) The user’s last name.

realmId string
username string
attributes Mapping[str, Any]

(Computed) A map representing attributes for the user

email str

(Computed) The user’s email.

email_verified bool

(Computed) Whether the email address was validated or not. Default to false.

enabled bool

(Computed) When false, this user cannot log in. Defaults to true.

federated_identities Sequence[str]

(Computed) The user’s federated identities, if applicable. This block has the following schema:

first_name str

(Computed) The user’s first name.

id str

The provider-assigned unique ID for this managed resource.

last_name str

(Computed) The user’s last name.

realm_id str
username str

Package Details

Repository
https://github.com/pulumi/pulumi-keycloak
License
Apache-2.0
Notes
This Pulumi package is based on the keycloak Terraform Provider.