Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  • get-account
    • Returns information about the indicated account or all accounts if the --account option is not specified. 

    • Accounts can be filtered:
      • The --enabled switch will filter results to active accounts
      • The --disabled switch will filter results to inactive accounts.
      • The --blocked switch will filter results to accounts that are blocked. The switch cannot be used with the --enabled and --disabled switches.
  • store-account
    • Stores an account to the Identity Service. 
      • An existing role can be assigned using the --role option.
      • The password can be specified using the --account-password option. Consider to use secure input from the commandline using the -a switch. If no password is specified then the initial password is assigned. If a password is specified or the initial password is used, then JOC Cockpit will challenge the user to specify a new password on next login.
      • The --force-password-change switch can be used to make JOC Cockpit challenge the user to specify a new password on next login. The operation is available for existing accounts that hold a password. For new accounts and for accounts assigned a new password users are automatically challenged to specify a new password on next login.
      • The --disabled switch can be used to deactivate an account when it is created. For later enabling/disabling of existing accounts see enable-account and disable-account commands.
    • Handling of passwords allows the API user to specify passwords for other accounts. However, for the affected accounts users will have to change the password on next login.
  • rename-account
    • Renames the indicated account.
  • remove-account
    • Removes the indicated account from the Identity Service.
  • get-account-permission
    • Returns the list of permissions per role assigned the given account.
  • set-account-password
    • Sets the password for the indicated account. Consider to use secure input from the commandline using the -a switch.
    • The user will be challenged to specify a new password on next login.
  • reset-account-password
    • Resets the account's password to the initial password.
    • The user will be challenged to specify a new password on next login.
  • enable-account
    • Activates the account which allows login to JOC Cockpit.
  • disable-account
    • Deactivates the account which denies login to JOC Cockpit.
  • block-account
    • Adds the account to the blocklist. The account will be denied login to JOC Cockpit.
    • A comment can be specified to indicate the reason for blocking the account.
  • unblock-account
    • Removes one or more accounts from the blocklist. The accounts will be allowed login to JOC Cockpit if they are activated/enabled.

Roles

  • get-role
    • Returns the indicated role if the --role option is used and otherwise returns all roles.
  • store-role
    • Stores a role from its name to JOC Cockpit. Default permissions will be applied to new roles.
    • The --ordering option can be used to specify the position of the role in the list of roles available for the given Identity Service.
  • rename-role
    • Renames an existing role.
  • remove-role
    • Removes the indicated role from the Identity Service.

...