Security

The Security API provides several pgutil commands (available as pgutil security) and HTTP endpoints to create, add, delete, and perform other operations on Users, Groups, Tasks and Permissions. All HTTP requests are made through the following base URL:

pgutil Commands

All HTTP endpoints of the Security API are available as pgutil commands.

To find the list of commands available in pgutil, simply run pgutil security --help. See Getting started with pgutil to learn more.

Available HTTP Endpoints

The Security API is comprised of endpoints for Users, Groups, Tasks and Permissions:

🙍‍♂️ User Management

For managing Users in ProGet.

• Create User - Creates a new User account
• Edit User - Modifies an existing User account
• Delete User - Deletes a User account
• Show User - Displays information about a User account*
• List Users - Lists User accounts

* Only available as a pgutil command.

🏢 Groups Management

For managing user Groups and Group membership in ProGet.

• Create Group - Creates a new Group
• Delete Group - Deletes a Group
• List Groups - Lists Groups
• Add Group Member - Adds a user to a Group*
• Remove Group Member - Removes a user from a Group*
• List Group Members - Lists members of a Group*

* Only available as a pgutil command.

⚒ Tasks Management

For managing and editing Tasks in ProGet, as well as creating, editing and deleting custom Tasks.

• Create Task - Creates a ProGet security Task
• Delete Task - Deletes a security Task from ProGet
• List Tasks - Lists security Tasks in ProGet
• List Task Attributes - List available security Task attributes

🔑 Permissions Management

For managing the Permissions of Users and Groups in ProGet.

• Add Permission - Adds a Permission
• Remove Permission - Removes a Permission
• List Permissions - Lists configured Permissions

Authenticating to Security API

The following is a summary of access types and their corresponding requirements for various API keys types and endpoints within this API. Note that Feed API keys cannot be used to authenticate to this API.

** Personal API keys are scoped to users and inherit the Tasks and attributes assigned to those users.

To specify an API Key, use the request header (X-ApiKey), querystring (key), or api:«api-key» as the username. See API Key Usage to learn more.

curl -X GET --header "X-ApiKey: abc12345" "https://proget.corp.local/api/security/users/list/"