Users

Couples a username, which can be referenced in other resource files, to one or multiple accounts used by said users.

Currently, a user’s name can only be coupled to their GitLab account through a GitLab ID.

There can only be a single Users resource specified in Frigg.

Schema

UsersResource

PropertyTypeRequiredDescription
versionstringYesVersion of Frigg to use. Should be 1.
kindUsersYesKind of resource you want to specify
specUserSpec arrayYesState you want the resource to have

UserSpec

PropertyTypeRequiredDescription
namestringYesName you can use in other resources to reference this user
gitlabIdnumberYesNumerical ID of the user’s GitLab account
blockedbooleanNoWhether the user is blocked. Used on self-managed instances to block/unblock GitLab users

Example

The following resource file allows Frigg to link the provided names to the user’s GitLab account for internal logic:

version: '1'
kind: Users
spec:
    - name: john.doe
      gitlabId: 02345678
    - name: alice.johnson
      gitlabId: 12345678
    - name: erik.klein
      gitlabId: 22345678
    - name: former.employee
      gitlabId: 32345678
      blocked: true

Note: On self-managed GitLab instances, Frigg can automatically export all non-bot users from the instance. Users marked as blocked: true will be blocked on the GitLab instance (and unblocked when the flag is removed). Blocked users are also excluded from member lists during export.