current_credentials
Creates, updates, deletes, gets or lists a current_credentials resource.
Overview​
| Name | current_credentials |
| Type | Resource |
| Id | ovh.auth.current_credentials |
Fields​
The following fields are returned by SELECT queries:
- get
successful operation
| Name | Datatype | Description |
|---|---|---|
application_id | integer | ID of associated API Application (wire: applicationId) |
credential_id | integer | ID of this credential (wire: credentialId) |
allowed_ips | array | If defined, list of ip blocks which are allowed to call API with this credential (wire: allowedIPs) |
creation | string (date-time) | Creation date of this credential |
expiration | string (date-time) | Expiration date of this credential |
last_use | string (date-time) | Last use date of this credential (wire: lastUse) |
ovh_support | boolean | States whether this credential has been created by yourself or by the OVH support team (wire: ovhSupport) |
rules | array | API routes allowed to this credential |
status | string | State of to this credential (expired, pendingValidation, refused, validated) |
Methods​
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get | select | Get the current credential details |
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 the current credential details
SELECT
application_id,
credential_id,
allowed_ips,
creation,
expiration,
last_use,
ovh_support,
rules,
status
FROM ovh.auth.current_credentials
;