identity_user_tokens

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

Overview

Name	identity_user_tokens
Type	Resource
Id	ovh.me.identity_user_tokens

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
name	string	Name of this token
creation	string (date-time)	Creation date of this token
description	string	Personal access token's description
expires_at	string (date-time)	Personal access token's expiration date (wire: expiresAt)
last_used	string (date-time)	Personal access token's last used date (wire: lastUsed)

list

A personal access token response

Name	Datatype	Description
name	string	Name of this token
creation	string (date-time)	Creation date of this token
description	string	Personal access token's description
expires_at	string (date-time)	Personal access token's expiration date (wire: expiresAt)
last_used	string (date-time)	Personal access token's last used date (wire: lastUsed)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	name, user		Get a personal access token's information
list	select	user	x_pagination_mode	Retrieve all personal access tokens from this user
create	insert	user, description, name		Create a new personal access token
update	update	name, user		Alter a user personal acces token
delete	delete	name, user		Delete a personal access token

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"}})
name	string	Name
user	string	User
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 a personal access token's information

SELECT
name,
creation,
description,
expires_at,
last_used
FROM ovh.me.identity_user_tokens
WHERE name = '{{ name }}' -- required
AND user = '{{ user }}' -- required
;

list

Retrieve all personal access tokens from this user

SELECT
name,
creation,
description,
expires_at,
last_used
FROM ovh.me.identity_user_tokens
WHERE user = '{{ user }}' -- required
AND x_pagination_mode = '{{ x_pagination_mode }}'
;

INSERT examples

create

Create a new personal access token

INSERT INTO ovh.me.identity_user_tokens (
description,
expires_at,
expires_in,
name,
user
)
SELECT 
'{{ description }}' /* required */,
'{{ expires_at }}',
{{ expires_in }},
'{{ name }}' /* required */,
'{{ user }}'
RETURNING
name,
creation,
description,
expires_at,
last_used,
token
;

Manifest

# Description fields are for documentation purposes
- name: identity_user_tokens
props:
  - name: user
    value: "{{ user }}"
    description: Required parameter for the identity_user_tokens resource.
  - name: description
    value: "{{ description }}"
    description: |
      Personal access token's description
  - name: expires_at
    value: "{{ expires_at }}"
    description: |
      Personal access token's expiration date
  - name: expires_in
    value: {{ expires_in }}
    description: |
      Duration (in seconds) of the token's validity
  - name: name
    value: "{{ name }}"
    description: |
      Personal access token's name

UPDATE examples

update

Alter a user personal acces token

UPDATE ovh.me.identity_user_tokens
SET 
description = '{{ description }}',
expires_at = '{{ expires_at }}',
expires_in = {{ expires_in }}
WHERE 
name = '{{ name }}' --required
AND user = '{{ user }}' --required
RETURNING
name,
creation,
description,
expires_at,
last_used;

DELETE examples

delete

Delete a personal access token

DELETE FROM ovh.me.identity_user_tokens
WHERE name = '{{ name }}' --required
AND user = '{{ user }}' --required
;