Examples of using okKoala CLI

GetCompanyName

If you are logged into the console, you can make sure you are logged into the right company. Use the koala GetCompanyName command - it displays the name of the company to which you are logged in.

If you do not see the correct name:

• you need to log into the web panel, select the context of another company, then generate a new token and log in again.
• contact the okKoala team, because the company name is entered by the service administrator, for example, instead of Ltd. you see Inc.

WeakestLink

With the koala WeakestLink command, you can find out what users did and when. In the processed version, as a table - pledge, it can be seen here: https://okkoala.com/app#/company/weakest-links

ListAudits

All commands of type List-* will retrieve iterable information. ListAudits will display a list of campaigns, as a list of objects from the database. Why might this list be different from the list in the web version? See the next command.

ArchiveAudit

If certain campaigns were set up on a test basis, or were canceled by mistake, you can archive them. The list of archived campaigns is available all the time, also in the web version, but the administrator has deemed them “non-presential.” If you want to archive a campaign, you can do so using ArchiveAudit. To see the required parameters Use koala help ArchiveAudit. It will see that you need the parameter id_audit and archived. So you can write something like this: koala ArchiveAudit --id_audit 625 --archived 1.

GetReport

If you want to retrieve the report data for the future (okKoala rule: no-vendor-lock), you can use the koala GetReport --id_audit 625 command.

AddDataRecord

This command will allow you to add a new user: AddDataRecord --last_name "A" --first_name "B" --email "C" --type "o365"

The value of the –type field can take the value “o365” (Microsoft login) or “email” (email account login).

GetEmployeeData

This command will retrieve information about the current user that the platform will use when processing in the training view.

ReadMyData

The ReadMyData command allows you to read all employee data.

ReadMyTags

The ReadMyTags command will retrieve information on all groups / tags within an organization.