ようこそ

Managing User Accounts in Server Installations

This section provides information to help system administrators of self-hosted CircleCI Server installations manage accounts for their users. For an overview of user accounts, view the Admin settings overview from the CircleCI app by clicking on your profile in the top right corner and selecting Admin. This overview provides the active user count and the total number of licensed users.

Accounts Overview
Figure 1. Admin Settings – Account Overview

Suspending Accounts

When an account is no longer required, you can suspend the account so it will no longer be active and will not count against your license quota. To suspend an account:

  1. Navigate to your CircleCI Admin Settings

  2. Select Users from the Admin Settings menu

  3. Scroll to locate the account in either the Active or Inactive window

  4. Click Suspend next to the account name and the account will appear in the Suspended window

Suspend a User Account
Figure 2. Suspending an Account

Reactivating a Suspended User Account

To reactivate an account that has been suspended:

  1. Navigate to your CircleCI Admin Settings

  2. Select Users from the Admin Settings menu

  3. View the Suspended window

  4. Click on Activate next to the User you wish to grant access and the account will appear in the Active window

Reactivate existing users
Figure 3. Rectivate Existing Users

Controlling Account Access

Any user associated with your GitHub.com or GitHub Enterprise organization can create a user account for your CircleCI installation. In order to control who has access, you can automatically suspend all new users, requiring an administrator to activate them before they can log in. To access this feature:

  1. Navigate to your CircleCI Admin Settings

  2. Select System Settings from the Admin Settings menu

  3. Set Suspend New Users to True

Suspend New Users
Figure 4. Auto Suspend New Users

Activating a Suspended New User Account

To activate an new account that was automatically suspended, and allow the associated user access to your installation of CircleCI Server:

  1. Navigate to your CircleCI Admin Settings

  2. Select Users from the Admin Settings menu

  3. View the Suspended New Users window

  4. Click on Activate next to the User you wish to grant access and the account will appear in the Active window

Activate New Users
Figure 5. Activate a Suspended New User

Limit User Registrations by GitHub Organization

When using github.com, you can limit who can register with your CircleCI install to people with some connection to your approved organizations list. To access this feature:

  1. Navigate to your CircleCI Admin Settings page

  2. Select System Settings from the Admin Setting menu

  3. Scroll down to Required Org Membership List

  4. Enter the organization(s) you wish to approve. If entering more than one organization, use a comma delimited string

Org Membership
Figure 6. Organization Membership
Any form of organization membership is within the scope of this approval feature, and it does not stop users from running builds associated with other organizations they may belong to.

Full User List

To view a full list of users for your CircleCI Server installation, first SSH into your Services machine, and then run:

circleci dev-console
(circle.model.user/where { :$and [{:sign_in_count {:$gte 0}}, {:login {:$ne nil}}]} :only [:login])

Deleting a User

If you have at any point changed your GitHub/Enterprise hostname associated with CircleCI, contact your account team before attempting to remove a user.

If you need to remove a user from your installation of CircleCI Server, you will need to SSH into the services machine first and then delete using the following command, substituting the user’s GitHub username:

circleci dev-console
(circle.http.api.admin-commands.user/delete-by-login-vcs-type! "github-username-of-user" :github)