user_states
Creates, updates, deletes, gets or lists a user_states resource.
Overview​
| Name | user_states |
| Type | Resource |
| Id | oci.identity.user_states |
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 |
|---|---|---|---|---|
update | update | userId, region | if-match | Updates the state of the specified user.<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. |
if-match | string | For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value. |
UPDATE examples​
- update
Updates the state of the specified user.<br />
UPDATE oci.identity.user_states
SET
blocked = {{ blocked }}
WHERE
userId = '{{ userId }}' --required
AND region = '{{ region }}' --required
AND if-match = '{{ if-match}}'
RETURNING
id,
name,
capabilities,
compartmentId,
dbUserName,
definedTags,
description,
email,
emailVerified,
externalIdentifier,
freeformTags,
identityProviderId,
inactiveStatus,
isMfaActivated,
lastSuccessfulLoginTime,
lifecycleState,
previousSuccessfulLoginTime,
timeCreated;