or_reset_ui_passwords
Creates, updates, deletes, gets or lists an or_reset_ui_passwords resource.
Overview​
| Name | or_reset_ui_passwords |
| Type | Resource |
| Id | oci.identity.or_reset_ui_passwords |
Fields​
The following fields are returned by SELECT queries:
SELECT not supported for this resource, use SHOW METHODS to view available operations for the resource.
Methods​
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
create | insert | userId, region | opc-retry-token | Creates a new Console one-time password for the specified user. For more information about user<br />credentials, see [User Credentials](/Content/Identity/usercred/usercredentials.htm).<br /><br />Use this operation after creating a new user, or if a user forgets their password. The new one-time<br />password is returned to you in the response, and you must securely deliver it to the user. They'll<br />be prompted to change this password the next time they sign in to the Console. If they don't change<br />it within 7 days, the password will expire and you'll need to create a new one-time password for the<br />user.<br /><br />(For tenancies that support identity domains) Resetting a user's password generates a reset password email<br />with a link that the user must follow to reset their password. If the user does not reset their password before the<br />link expires, you'll need to reset the user's password again.<br /><br />Note: The user's Console login is the unique name you specified when you created the user<br />(see [CreateUser](#/en/identity/20160918/User/CreateUser)).<br /> |
Parameters​
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
region | string | OCI region identifier (e.g. us-ashburn-1, ap-sydney-1); resolves from OCI_REGION when not supplied in the query. (default: us-ashburn-1, x-stackQL-envVar: OCI_REGION) |
userId | string | The OCID of the user. |
opc-retry-token | string | A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (e.g., if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected). |
INSERT examples​
- create
- Manifest
Creates a new Console one-time password for the specified user. For more information about user<br />credentials, see [User Credentials](/Content/Identity/usercred/usercredentials.htm).<br /><br />Use this operation after creating a new user, or if a user forgets their password. The new one-time<br />password is returned to you in the response, and you must securely deliver it to the user. They'll<br />be prompted to change this password the next time they sign in to the Console. If they don't change<br />it within 7 days, the password will expire and you'll need to create a new one-time password for the<br />user.<br /><br />(For tenancies that support identity domains) Resetting a user's password generates a reset password email<br />with a link that the user must follow to reset their password. If the user does not reset their password before the<br />link expires, you'll need to reset the user's password again.<br /><br />Note: The user's Console login is the unique name you specified when you created the user<br />(see [CreateUser](#/en/identity/20160918/User/CreateUser)).<br />
INSERT INTO oci.identity.or_reset_ui_passwords (
userId,
region,
opc-retry-token
)
SELECT
'{{ userId }}',
'{{ region }}',
'{{ opc-retry-token }}'
RETURNING
inactiveStatus,
lifecycleState,
password,
timeCreated,
userId
;
# Description fields are for documentation purposes
- name: or_reset_ui_passwords
props:
- name: userId
value: "{{ userId }}"
description: Required parameter for the or_reset_ui_passwords resource.
- name: region
value: "{{ region }}"
description: Required parameter for the or_reset_ui_passwords resource.
- name: opc-retry-token
value: "{{ opc-retry-token }}"
description: A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (e.g., if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).
description: A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (e.g., if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).