access_restriction_totps

Creates, updates, deletes, gets or lists an access_restriction_totps resource.

Overview

Name	access_restriction_totps
Type	Resource
Id	ovh.me.access_restriction_totps

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
id	integer	The Id of the restriction
creation_date	string (date-time)	Creation date (wire: creationDate)
description	string	Description of this TOTP
last_used_date	string (date-time)	Last used date (wire: lastUsedDate)
status	string	Status of this account (disabled, enabled, needCodeValidation, needEmailValidation)

list

TOTP Two-Factor Authentication

Name	Datatype	Description
id	integer	The Id of the restriction
creation_date	string (date-time)	Creation date (wire: creationDate)
description	string	Description of this TOTP
last_used_date	string (date-time)	Last used date (wire: lastUsedDate)
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	id		Get this object properties
list	select		x_pagination_mode	List of TOTP accounts
create	insert			Add a TOTP access restriction
update	update	id		Alter this object properties
delete	delete	id		Delete this Two-Factor
disable	exec	id, code		Disable this TOTP account
enable	exec	id, code		Enable this TOTP account
validate	exec	id, code		Validate your TOTP 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"}})
id	integer	The Id of the restriction
x_pagination_mode	string	Sent as CachedObjectList-Pages by default so the list returns the full objects rather than their identifiers. (wire: X-Pagination-Mode)

SELECT examples

get

Get this object properties

SELECT
id,
creation_date,
description,
last_used_date,
status
FROM ovh.me.access_restriction_totps
WHERE id = '{{ id }}' -- required
;

list

List of TOTP accounts

SELECT
id,
creation_date,
description,
last_used_date,
status
FROM ovh.me.access_restriction_totps
WHERE x_pagination_mode = '{{ x_pagination_mode }}'
;

INSERT examples

create

Add a TOTP access restriction

INSERT INTO ovh.me.access_restriction_totps (
api_host
)
SELECT 
'{{ api_host }}'
RETURNING
id,
qrcode_helper,
secret
;

Manifest

# Description fields are for documentation purposes
- name: access_restriction_totps
props:

UPDATE examples

update

Alter this object properties

UPDATE ovh.me.access_restriction_totps
SET 
description = '{{ description }}'
WHERE 
id = '{{ id }}' --required;

DELETE examples

delete

Delete this Two-Factor

DELETE FROM ovh.me.access_restriction_totps
WHERE id = '{{ id }}' --required
;

Lifecycle Methods

EXEC variables use wire (API) names.

disable

Disable this TOTP account

EXEC ovh.me.access_restriction_totps.disable 
@id='{{ id }}' --required 
@@json=
'{
"code": "{{ code }}"
}'
;

enable

Enable this TOTP account

EXEC ovh.me.access_restriction_totps.enable 
@id='{{ id }}' --required 
@@json=
'{
"code": "{{ code }}"
}'
;

validate

Validate your TOTP account

EXEC ovh.me.access_restriction_totps.validate 
@id='{{ id }}' --required 
@@json=
'{
"code": "{{ code }}"
}'
;