Cloud account information#
In examples of API authentication requests, and other examples where we are teaching the use of the API and expect that users might copy the code and use it, use variables or the following standard values for account numbers, usernames, passwords, API keys, and so on. Format the variables by using camelCase and italics, and also use bold within the examples.
Information | Use | Don't use |
---|---|---|
Account or tenant ID | yourAccountId yourTenantId
|
658405 |
Username | yourUsername
|
robb4554 |
Password | yourPassword
|
J$12345* |
API key | yourApiKey
|
of938go4915e114f7ff5448910fee68c |
Authentication token | xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
|
2e356864f39831523c184to646b1997b |
In example API operation requests and responses, in which we want users
to see actual values from the system, use "real-looking" values that are
nevertheless obviously made up, such the following one for
X-Auth-Token
:
abcdef123ghi4j5k67m8910n12op3qrs
Warning
Don't include or show actual writer or user account credentials in code examples or screenshots.