oci.Identity.UiPassword
Explore with Pulumi AI
This resource provides the Ui Password resource in Oracle Cloud Infrastructure Identity service.
Creates a new Console one-time password for the specified user. For more information about user credentials, see User Credentials.
Use this operation after creating a new user, or if a user forgets their password. The new one-time password is returned to you in the response, and you must securely deliver it to the user. They’ll be prompted to change this password the next time they sign in to the Console. If they don’t change it within 7 days, the password will expire and you’ll need to create a new one-time password for the user.
Note: The user’s Console login is the unique name you specified when you created the user (see CreateUser).
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";
const testUiPassword = new oci.identity.UiPassword("test_ui_password", {userId: testUser.id});
import pulumi
import pulumi_oci as oci
test_ui_password = oci.identity.UiPassword("test_ui_password", user_id=test_user["id"])
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.NewUiPassword(ctx, "test_ui_password", &Identity.UiPasswordArgs{
UserId: pulumi.Any(testUser.Id),
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Oci = Pulumi.Oci;
return await Deployment.RunAsync(() =>
{
var testUiPassword = new Oci.Identity.UiPassword("test_ui_password", new()
{
UserId = testUser.Id,
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.Identity.UiPassword;
import com.pulumi.oci.Identity.UiPasswordArgs;
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 testUiPassword = new UiPassword("testUiPassword", UiPasswordArgs.builder()
.userId(testUser.id())
.build());
}
}
resources:
testUiPassword:
type: oci:Identity:UiPassword
name: test_ui_password
properties:
userId: ${testUser.id}
Create UiPassword Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new UiPassword(name: string, args: UiPasswordArgs, opts?: CustomResourceOptions);
@overload
def UiPassword(resource_name: str,
args: UiPasswordArgs,
opts: Optional[ResourceOptions] = None)
@overload
def UiPassword(resource_name: str,
opts: Optional[ResourceOptions] = None,
user_id: Optional[str] = None)
func NewUiPassword(ctx *Context, name string, args UiPasswordArgs, opts ...ResourceOption) (*UiPassword, error)
public UiPassword(string name, UiPasswordArgs args, CustomResourceOptions? opts = null)
public UiPassword(String name, UiPasswordArgs args)
public UiPassword(String name, UiPasswordArgs args, CustomResourceOptions options)
type: oci:Identity:UiPassword
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args UiPasswordArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args UiPasswordArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args UiPasswordArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args UiPasswordArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args UiPasswordArgs
- 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 uiPasswordResource = new Oci.Identity.UiPassword("uiPasswordResource", new()
{
UserId = "string",
});
example, err := Identity.NewUiPassword(ctx, "uiPasswordResource", &Identity.UiPasswordArgs{
UserId: pulumi.String("string"),
})
var uiPasswordResource = new UiPassword("uiPasswordResource", UiPasswordArgs.builder()
.userId("string")
.build());
ui_password_resource = oci.identity.UiPassword("uiPasswordResource", user_id="string")
const uiPasswordResource = new oci.identity.UiPassword("uiPasswordResource", {userId: "string"});
type: oci:Identity:UiPassword
properties:
userId: string
UiPassword 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 UiPassword resource accepts the following input properties:
- User
Id string The OCID of the user.
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- User
Id string The OCID of the user.
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- user
Id String The OCID of the user.
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- user
Id string The OCID of the user.
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- user_
id str The OCID of the user.
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- user
Id String The OCID of the user.
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
Outputs
All input properties are implicitly available as output properties. Additionally, the UiPassword resource produces the following output properties:
- Id string
- The provider-assigned unique ID for this managed resource.
- Inactive
Status string - The detailed status of INACTIVE lifecycleState.
- Password string
- The user's password for the Console.
- State string
- The password's current state.
- Time
Created string - Date and time the password was created, in the format defined by RFC3339. Example:
2016-08-25T21:10:29.600Z
- Id string
- The provider-assigned unique ID for this managed resource.
- Inactive
Status string - The detailed status of INACTIVE lifecycleState.
- Password string
- The user's password for the Console.
- State string
- The password's current state.
- Time
Created string - Date and time the password was created, in the format defined by RFC3339. Example:
2016-08-25T21:10:29.600Z
- id String
- The provider-assigned unique ID for this managed resource.
- inactive
Status String - The detailed status of INACTIVE lifecycleState.
- password String
- The user's password for the Console.
- state String
- The password's current state.
- time
Created String - Date and time the password was created, in the format defined by RFC3339. Example:
2016-08-25T21:10:29.600Z
- id string
- The provider-assigned unique ID for this managed resource.
- inactive
Status string - The detailed status of INACTIVE lifecycleState.
- password string
- The user's password for the Console.
- state string
- The password's current state.
- time
Created string - Date and time the password was created, in the format defined by RFC3339. Example:
2016-08-25T21:10:29.600Z
- id str
- The provider-assigned unique ID for this managed resource.
- inactive_
status str - The detailed status of INACTIVE lifecycleState.
- password str
- The user's password for the Console.
- 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
- id String
- The provider-assigned unique ID for this managed resource.
- inactive
Status String - The detailed status of INACTIVE lifecycleState.
- password String
- The user's password for the Console.
- state String
- The password's current state.
- time
Created String - Date and time the password was created, in the format defined by RFC3339. Example:
2016-08-25T21:10:29.600Z
Look up Existing UiPassword Resource
Get an existing UiPassword 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?: UiPasswordState, opts?: CustomResourceOptions): UiPassword
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
inactive_status: Optional[str] = None,
password: Optional[str] = None,
state: Optional[str] = None,
time_created: Optional[str] = None,
user_id: Optional[str] = None) -> UiPassword
func GetUiPassword(ctx *Context, name string, id IDInput, state *UiPasswordState, opts ...ResourceOption) (*UiPassword, error)
public static UiPassword Get(string name, Input<string> id, UiPasswordState? state, CustomResourceOptions? opts = null)
public static UiPassword get(String name, Output<String> id, UiPasswordState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
- name
- The unique name of the resulting resource.
- id
- 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
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- 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
- The unique name of the resulting resource.
- id
- 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
- The unique name of the resulting resource.
- id
- 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.
- Inactive
Status string - The detailed status of INACTIVE lifecycleState.
- Password string
- The user's password for the Console.
- State string
- The password's current state.
- Time
Created string - Date and time the password was created, in the format defined by RFC3339. Example:
2016-08-25T21:10:29.600Z
- User
Id string The OCID of the user.
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- Inactive
Status string - The detailed status of INACTIVE lifecycleState.
- Password string
- The user's password for the Console.
- State string
- The password's current state.
- Time
Created string - Date and time the password was created, in the format defined by RFC3339. Example:
2016-08-25T21:10:29.600Z
- User
Id string The OCID of the user.
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- inactive
Status String - The detailed status of INACTIVE lifecycleState.
- password String
- The user's password for the Console.
- state String
- The password's current state.
- time
Created String - Date and time the password was created, in the format defined by RFC3339. Example:
2016-08-25T21:10:29.600Z
- user
Id String The OCID of the user.
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- inactive
Status string - The detailed status of INACTIVE lifecycleState.
- password string
- The user's password for the Console.
- state string
- The password's current state.
- time
Created string - Date and time the password was created, in the format defined by RFC3339. Example:
2016-08-25T21:10:29.600Z
- user
Id string The OCID of the user.
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- inactive_
status str - The detailed status of INACTIVE lifecycleState.
- password str
- The user's password for the Console.
- 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.
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- inactive
Status String - The detailed status of INACTIVE lifecycleState.
- password String
- The user's password for the Console.
- state String
- The password's current state.
- time
Created String - Date and time the password was created, in the format defined by RFC3339. Example:
2016-08-25T21:10:29.600Z
- user
Id String The OCID of the user.
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
Import
Import is not supported for this resource.
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- oci pulumi/pulumi-oci
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
oci
Terraform Provider.