Credentials API
- Alvaro de la Serna Martinez
Overview
API versions
Please note that newer versions of this API may include pure additions to it (such as new properties on resources returned from an action, accepting these resources with or without the property inbound to the server, or adding new resources or actions), or new appearance of properties within JSON structures because we assume that clients use forgiving, non-strict parsing on the JSON they receive from Devo.
New versions of the API will always be backwards compatible, using a never remove, only add strategy.
Contact us if you have any questions.
The Devo Credentials API can be used to:
Create, retrieve, rename, and delete tokens, as well as enable or disable them.
To perform a request with the Credentials API, use the endpoint corresponding to your Devo region.
Every Credentials API response sends a special header named x-devo-cid, which contains the correlation ID generated for the request. In case of any problem, contact us and include this value in the message so that we can trace the problem more effectively.
Names format
Common and multitenant domain names
The name format for common and multitenant domains is not the same. Common domains have regular names (with certain character restrictions, but they don't need to follow a fixed format), while multitenant domain names are followed by the name of the multitenant they belong to, separated by an @ (e.g, domain_name@multitenant).
This tail can be ignored when you create a new multitenant domain, but remember that it must be added in all the operations that require the domain name; otherwise, they will return an error. For example, if you create a domain called “my_domain” in the “test” multitenant, you will have a domain called “my_domain@test”. Any further operations will require this name format to work properly.
Name validation
Regular names, like domain names, can only contain specific characters and should match the regular expression [a-z0-9_-]{1,100}. Essentially, this requires the name to have a maximum of 100 characters, and only use lowercase letters, numbers, or the special characters _ and -.
User names have fewer restrictions, allowing things such as accents, dots, @ characters, etc.