Account Services (Admin API)
The Account Services API lets account administrators (admins) manage users and view information for their account. Account Services tasks can be performed using the MGP Pro admin user interface (UI) or through direct API access. Admins can view their account details and manage users in their account.
MGP Pro administration documentation
Account Services API Collection zip file
Permissions level required:
Admin
Password Management
Access to the MGP Pro user interfaces and APIs require an MGP account with a valid username and password. Passwords expire every 90 days and must be reset.
Account users can reset their own passwords by following these instructions: Manage Your Password.
Admins can send a password reset email to users through the UI or through direct API access. To send a password reset email using the UI, following these instructions for the UI Resetting User Passwords. To send a password reset email using the API, submit a Send Password Reset Email call.
User guides and examples
| Page | Topic |
|---|---|
| Account Services Guide | An overview of the Account Services API collection. |
| Accounts Guide | A list of all available Account Services calls related to Accounts. |
| Activations Guide | A list of all available Account Services calls related to Activations. |
| Products Guide | A list of all available Account Services calls related to Products. |
| Rate Tables Guide | A list of all available Account Services calls related to Rate Tables. |
| Roles Guide | A list of all available Account Services calls related to Roles. |
| Scopes Guide | A list of all available Account Services calls related to Scopes. |
| Users Guide | A list of all available Account Services calls related to Users. |
API references
| Page | Topic |
|---|---|
POST Get an OAuth2 bearer token | Get an OAuth2 bearer token for authentication use in this API collection. |
Accounts
| Page | Topic |
|---|---|
GET Get Account Details | Get the details for your account. |
GET Get Account Usage | Get the usage for your account. |
Activations
| Page | Topic |
|---|---|
GET Get a list of available activations | Get a list of activations available to your account. |
GET Get an activation by activationId | Get the details of an activation using its activationId. |
GET Get an activation by activation number | Get the details of an activation using its activation number. |
GET Get georestrictions attached to activation | Get any georestrictions attached to a specific activation. |
GET Get georestriction masks attached to activation | Get any georestriction masks attached to a specific activation. |
GET Get activation's credit limit | Get the credit limit for a specific activation. |
GET Get activation's usage | Get the current usage of a specific activation. |
Products
| Page | Topic |
|---|---|
GET Get a list of products | Get a list of products available to your account. |
Rate Tables
| Page | Topic |
|---|---|
GET Get rate tables | Get a list of rate tables available to your account. |
GET Get rate table by ID | Get the details of a rate table using its ID. |
GET Get activations for rate table | Get all activations that are using a specific rate table. |
GET Get product credit rates for rate tables | Get a list of all product credits. |
GET Get product credit rates for a rate table | Get a breakdown of how many credits it costs to order a unit of various products for a specific rate table. |
GET Get credit rates for single product in rate table | Get how many credits it costs to order a unit of a specific product for a specific rate table. |
GET Get rate tables and associated activation numbers | Get a list of all rate tables available to your account and the associated activations that are able to use that rate table. |
GET Get rate table prod cred by activation number | Get the rate table associated with a specific activation and the cost per unit of all available products. |
GET Get a list of all credit unit types | Get a list all credit unit types. |
Roles
| Page | Topic |
|---|---|
GET Get roles account | Get the roles available for your account. |
GET Get a list of user types | Get all user types. |
GET Get role by ID | Get a role by ID. |
Scopes
| Page | Topic |
|---|---|
GET Get Scopes | Get the scopes available for your account. |
GET Get Scopes by ID | Get scopes by ID. |
GET Get Scopes by Name | Get scopes by scope name. |
Users
| Page | Topic |
|---|---|
POST Add a new user | Add a new user to your account. |
POST Assign roles to a user | Assign roles to a user that have not already been assigned at the account or activation level. |
POST Remove role from a user | Remove roles from a user. This can include roles assigned at the, account, activation, or user level. |
GET Get a list of users | Get a list of all users associated with your account. |
PUT Send a password reset email | Send a password reset email to a specific user. |
GET Get all roles assigned to and available for a user | Get all assigned roles and available roles for a specific user. |
GET Get all roles assigned to a user | Get all the roles currently assigned to a specific user. |
GET Get a user by username | Get a specific user by their username (email address). |
DEL Delete a user | Delete a user. |
GET Get users' usage | Get the credit usage for all users associated with your account. |
PUT Update a user | Update information associated with a specific user. |
GET Get georestrictions | Get the georestrictions associated with a specific user. |
GET Get georestricion masks | Get the georestriction masks associated with a specific user. |
GET Export user data | Export a CSV file of all user data associated with your account. |