Getting started / Organizations

Getting started

Organizations

Sharing binaries, profiles, jobs and API keys with your team, and who can do what.

Everything in GuardPkg belongs to an organization: binaries, profiles, jobs and API keys. You start with a personal organization that's only yours. To work with others, create an organization and invite them. Everyone in it sees and uses the same things.

Switching#

The menu at the top of the dashboard's sidebar shows the organization you're working in. Pick another there to switch; the dashboard then shows that organization's binaries and jobs. Each browser session remembers its own choice.

An API key belongs to the organization you were in when you created it, so a pipeline always works in one organization whoever is signed in.

Creating one#

Choose New organization in the menu and give it a name. You become its owner.

Inviting people#

On the Organization page, owners and admins create invitation links:

  • A link works once and expires after 7 days. It's shown once, so copy it then.
  • Lock it to an email address if you like; then only that account can use it.
  • Invite someone as a member or an admin. Make them an owner once they've joined.
  • Someone without a GuardPkg account can create one from the link, without a separate invite code.

Pending invitations are listed on the same page, where they can be revoked.

Roles#

Member Admin Owner
Upload binaries, run jobs, edit profiles ✓ ✓ ✓
Create API keys, revoke their own ✓ ✓ ✓
Revoke anyone's API keys ✓ ✓
Invite people, change members' and admins' roles, remove them ✓ ✓
Make or remove owners, rename or delete the organization ✓

An organization always has at least one owner, so the last owner can't leave or step down until they've made someone else an owner.

Leaving and removing#

Anyone can leave an organization from its page; owners and admins can remove others. Either way, the API keys that person created in the organization stop working, and their browser sessions go back to their personal organization. What they uploaded stays with the organization.

Deleting an organization#

An owner can delete an organization from its page once it has no jobs queued or running. Its binaries, profiles, jobs, results and API keys are deleted for everyone, and can't be recovered. Your personal organization can't be deleted, shared or renamed.