Skip to main content

details

Creates, updates, deletes, gets or lists a details resource.

Overview​

Namedetails
TypeResource
Idovh.auth.details

Fields​

The following fields are returned by SELECT queries:

successful operation

NameDatatypeDescription
accountstringCustomer identifier
allowed_routesarrayAllowed API routes, null means everything (wire: allowedRoutes)
descriptionstringDescription of the authenticated identity
identitiesarrayIdentities of the current session: corresponds to all the authentication provider identities that could be used to match IAM policies
methodstringAuthentication method (account, oauth2_client_credentials, provider, user)
rolesarrayRoles of the authenticated identity
userstringUsername of the authenticated identity

Methods​

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
getselectDetails about the current authentication

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.

NameDatatypeDescription
api_hoststringThe 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​

Details about the current authentication

SELECT
account,
allowed_routes,
description,
identities,
method,
roles,
user
FROM ovh.auth.details
;