pre_co_user_credentials
Creates, updates, deletes, gets or lists a pre_co_user_credentials resource.
Overview​
| Name | pre_co_user_credentials |
| Type | Resource |
| Id | oci.kms.pre_co_user_credentials |
Fields​
The following fields are returned by SELECT queries:
- get
The request is processed successfully. The preCo username and password will be returned in the body of the response. Copy credentials for your records will not be shown again.
| Name | Datatype | Description |
|---|---|---|
password | string | The base 64 encoded pre crypto officer password. |
username | string | The pre crypto officer username, which should be chosen as a non confidential string. |
Methods​
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get | select | hsmClusterId, region | opc-request-id, opc-retry-token | Retrieves Pre Crypto Officer user credentials for the specified HSM cluster.<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 |
|---|---|---|
hsmClusterId | string | The OCID of the HSM Cluster. This is a unique identifier assigned to each hsmCluster. |
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) |
opc-request-id | string | Unique identifier for the request. If provided, the returned request ID will include this value. Otherwise, a random request ID will be generated by the service. |
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). |
SELECT examples​
- get
Retrieves Pre Crypto Officer user credentials for the specified HSM cluster.<br />
SELECT
password,
username
FROM oci.kms.pre_co_user_credentials
WHERE hsmClusterId = '{{ hsmClusterId }}' -- required
AND region = '{{ region }}' -- required
AND opc-request-id = '{{ opc-request-id }}'
AND opc-retry-token = '{{ opc-retry-token }}'
;