Configuration
Atlas requires a few the following information before any calls can be made.
- Development Environment (e.g. QA5, LB1)
- Currently logged in account user
config
The config
function may be called with a JSON blob to set the current configuration,
or without parameters to retrieve the configuration.
atlas.config({
apiBaseUrl: "https://api.ctl.io",
controlBaseUrl: "https://control.ctl.io",
bearerToken: "Provided by SSO",
rootAccountAlias: "Provided by SSO",
userName: "Provided by SSO"
});
var currentConfig = atlas.config();
Configuration Parameters
Name | Type | Required | Description |
---|---|---|---|
apiBaseUrl | string | yes | Base url of the CTL API, for example "https://api.ctl.io" |
controlBaseUrl | string | yes | Base url of the CTL Control Portal, for example "https://control.ctl.io" |
userName | string | yes | Currently logged in user, is provided during SSO exchnage. |
bearerToken | string | yes | User's bearerToken, is provided during SSO exchnage. Used to make API request on behalf of the user. |
rootAccountAlias | string | yes | The account alias of the root account for the logged in user, is provided during SSO exchnage. |
Atlas does not perform SSO, it is the responsibility of the satellite application.