Skip to main content
Version: 1.13.0

4. Get System Access Data

To work with OMNI Platform, the user needs to have credentials to sign in the web interface, the Platform URL, and the API access token. How to obtain this information is described below.

4.1. Get User Password and Email

The user password and mail can be found in settings.env Platform configuration file in the PLATFORM_DEFAULT_PASSWORD and PLATFORM_DEFAULT_EMAIL variables, respectively.

4.2. Get URL of Deployed Server

OMNI Platform deployment domain is specified in `settings.env` file in `DOMAIN` variable.

As a result, access to the Platform can be obtained by URL: http://platform.$DOMAIN

For example: http://your-company.com

4.3. Get Access Token

To get API access token for a user registered with PLATFORM_DEFAULT_EMAIL, run the command below:

$ ./setup/get-token.sh

You can also open OMNI Platform web-interface in web browser using URL from the previous section. Sign in to the Platform using the user credentials from section 4.1, follow the Platform API link in Resources panel of the home page, and submit the following request in GraphQL console:

query{
me {
workspaces {
accesses {
id
}
}
}
}

As a result, GraphQL returns the response with access token:

{
"data": {
"me": {
"workspaces": [
{
"accesses ": [
{
"id": "3460***"
}
]
}
]
}
}
}

API access token is given in id field.