Octopus Deploy Documentation

Admin

Last updated

Use the admin command to reset admin user passwords, re-enable them, and ensure they are in the admin group.

Admin options

Usage: octopus.server admin [<options>]

Where [<options>] is any of:

      --instance=VALUE       Name of the instance to use
      --wait=VALUE           Milliseconds to wait
      --username, --user=VALUE
                             The username of the administrator to
                               create/modify
      --email=VALUE          The email of the administrator to create/modify
      --password=VALUE       The password to set for the administrator
      --apiKey=VALUE         The API Key to set for the administrator. If
                               this is set and no password is provided then a
                               service account user will be created. If this is
                               set and a password is also set then a standard
                               user will be created.
      --externalGroup=VALUE  The partial name of an Active Directory group to
                               add to the administrators team
      --externalGroupId, --externalRoleId=VALUE
                             The id of an external (e.g. AzureAD, Okta)
                               group/role to add to the administrators team
      --externalGroupDescription, --externalRoleDescription=VALUE
                             The description of an external (e.g. AzureAD,
                               Okta) group/role to add to the administrators
                               team
      --skipDatabaseCompatibilityCheck
                             Skips the database compatibility check
      --skipDatabaseSchemaUpgradeCheck
                             Skips the database schema upgrade checks. Use
                               with caution

Or one of the common options:

      --help                 Show detailed help for this command

Welcome! We use cookies and data about how you use our website allow us to improve the website and your experience, and resolve technical errors. Our website uses cookies and shares some of your data with third party analytics companies for these purposes.

If you decline, we will respect your privacy. A single cookie will be used in your browser to remember your preference.