access_restriction_backup_codes
Creates, updates, deletes, gets or lists an access_restriction_backup_codes resource.
Overview​
| Name | access_restriction_backup_codes |
| Type | Resource |
| Id | ovh.me.access_restriction_backup_codes |
Fields​
The following fields are returned by SELECT queries:
- get
successful operation
| Name | Datatype | Description |
|---|---|---|
creation_date | string (date-time) | Creation date (wire: creationDate) |
last_used_date | string (date-time) | Last used date (wire: lastUsedDate) |
remaining | integer | Number of remaining codes |
status | string | Status of this account (disabled, enabled, needCodeValidation, needEmailValidation) |
Methods​
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get | select | Get this object properties | ||
create | insert | Add a SOTP access restriction | ||
delete | delete | Delete this Two-Factor | ||
disable | exec | code | Disable this SOTP account | |
enable | exec | code | Enable this SOTP account | |
validate | exec | code | Validate your SOTP account |
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 |
|---|---|---|
api_host | string | The OVHcloud API host. Selected by OVH_ENDPOINT (ovh-eu, ovh-ca or ovh-us; default ovh-eu). (default: api.eu.ovhcloud.com, x-stackQL-envVarSelector: {"envVar":"OVH_ENDPOINT","default":"ovh-eu","values":{"ovh-eu":"api.eu.ovhcloud.com","ovh-ca":"api.ca.ovhcloud.com","ovh-us":"api.us.ovhcloud.com"}}) |
SELECT examples​
- get
Get this object properties
SELECT
creation_date,
last_used_date,
remaining,
status
FROM ovh.me.access_restriction_backup_codes
;
INSERT examples​
- create
- Manifest
Add a SOTP access restriction
INSERT INTO ovh.me.access_restriction_backup_codes (
api_host
)
SELECT
'{{ api_host }}'
RETURNING
codes
;
# Description fields are for documentation purposes
- name: access_restriction_backup_codes
props:
DELETE examples​
- delete
Delete this Two-Factor
DELETE FROM ovh.me.access_restriction_backup_codes
;
Lifecycle Methods​
EXEC variables use wire (API) names.
- disable
- enable
- validate
Disable this SOTP account
EXEC ovh.me.access_restriction_backup_codes.disable
@@json=
'{
"code": "{{ code }}"
}'
;
Enable this SOTP account
EXEC ovh.me.access_restriction_backup_codes.enable
@@json=
'{
"code": "{{ code }}"
}'
;
Validate your SOTP account
EXEC ovh.me.access_restriction_backup_codes.validate
@@json=
'{
"code": "{{ code }}"
}'
;