Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. Identity
  5. getUiPassword
Oracle Cloud Infrastructure v2.30.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-oci

oci.Identity.getUiPassword

Explore with Pulumi AI

Oracle Cloud Infrastructure v2.30.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-oci

This data source provides details about a specific Ui Password resource in Oracle Cloud Infrastructure Identity service.

Gets the specified user’s console password information. The returned object contains the user’s OCID, but not the password itself. The actual password is returned only when created or reset.

Example Usage

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

const testUiPassword = oci.Identity.getUiPassword({
    userId: testUser.id,
});
Copy
import pulumi
import pulumi_oci as oci

test_ui_password = oci.Identity.get_ui_password(user_id=test_user["id"])
Copy
package main

import (
	"github.com/pulumi/pulumi-oci/sdk/v2/go/oci/identity"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := identity.GetUiPassword(ctx, &identity.GetUiPasswordArgs{
			UserId: testUser.Id,
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Oci = Pulumi.Oci;

return await Deployment.RunAsync(() => 
{
    var testUiPassword = Oci.Identity.GetUiPassword.Invoke(new()
    {
        UserId = testUser.Id,
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.Identity.IdentityFunctions;
import com.pulumi.oci.Identity.inputs.GetUiPasswordArgs;
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 testUiPassword = IdentityFunctions.getUiPassword(GetUiPasswordArgs.builder()
            .userId(testUser.id())
            .build());

    }
}
Copy
variables:
  testUiPassword:
    fn::invoke:
      function: oci:Identity:getUiPassword
      arguments:
        userId: ${testUser.id}
Copy

Using getUiPassword

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 getUiPassword(args: GetUiPasswordArgs, opts?: InvokeOptions): Promise<GetUiPasswordResult>
function getUiPasswordOutput(args: GetUiPasswordOutputArgs, opts?: InvokeOptions): Output<GetUiPasswordResult>
Copy
def get_ui_password(user_id: Optional[str] = None,
                    opts: Optional[InvokeOptions] = None) -> GetUiPasswordResult
def get_ui_password_output(user_id: Optional[pulumi.Input[str]] = None,
                    opts: Optional[InvokeOptions] = None) -> Output[GetUiPasswordResult]
Copy
func GetUiPassword(ctx *Context, args *GetUiPasswordArgs, opts ...InvokeOption) (*GetUiPasswordResult, error)
func GetUiPasswordOutput(ctx *Context, args *GetUiPasswordOutputArgs, opts ...InvokeOption) GetUiPasswordResultOutput
Copy

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

public static class GetUiPassword 
{
    public static Task<GetUiPasswordResult> InvokeAsync(GetUiPasswordArgs args, InvokeOptions? opts = null)
    public static Output<GetUiPasswordResult> Invoke(GetUiPasswordInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetUiPasswordResult> getUiPassword(GetUiPasswordArgs args, InvokeOptions options)
public static Output<GetUiPasswordResult> getUiPassword(GetUiPasswordArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: oci:Identity/getUiPassword:getUiPassword
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

UserId This property is required. string
The OCID of the user.
UserId This property is required. string
The OCID of the user.
userId This property is required. String
The OCID of the user.
userId This property is required. string
The OCID of the user.
user_id This property is required. str
The OCID of the user.
userId This property is required. String
The OCID of the user.

getUiPassword Result

The following output properties are available:

Id string
InactiveStatus string
Password string
State string
The password's current state.
TimeCreated string
Date and time the password was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
UserId string
The OCID of the user.
Id string
InactiveStatus string
Password string
State string
The password's current state.
TimeCreated string
Date and time the password was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
UserId string
The OCID of the user.
id String
inactiveStatus String
password String
state String
The password's current state.
timeCreated String
Date and time the password was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
userId String
The OCID of the user.
id string
inactiveStatus string
password string
state string
The password's current state.
timeCreated string
Date and time the password was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
userId string
The OCID of the user.
id str
inactive_status str
password str
state str
The password's current state.
time_created str
Date and time the password was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
user_id str
The OCID of the user.
id String
inactiveStatus String
password String
state String
The password's current state.
timeCreated String
Date and time the password was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
userId String
The OCID of the user.

Package Details

Repository
oci pulumi/pulumi-oci
License
Apache-2.0
Notes
This Pulumi package is based on the oci Terraform Provider.
Oracle Cloud Infrastructure v2.30.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-oci