Company Users

GET

/v3/companyActivity/users

GET

/v3/companyActivity/users

curl https://api.megaport.com/v3/companyActivity/users

200Retrieved

{
  "data": [
    {
      "uid": "1449df16-2c2e-4d94-bafd-bd5e194f796c",
      "userName": "Carlos Mendes",
      "userType": "USER"
    },
    {
      "uid": "dc7e7845-51d8-4845-882b-b8349f624574",
      "userName": "Elira Mondai",
      "userType": "USER"
    },
    {
      "uid": "2f27647d-ec6d-4fc9-8ac6-e9edfd4ef004",
      "userName": "Emily Dubois",
      "userType": "USER"
    },
    {
      "uid": "ln7tf4ugame3ufol4u9ja623p",
      "userName": "GB FOR TESTING",
      "userType": "M2M"
    },
    {
      "uid": "6db11479-4465-434b-818a-40407d9e365f",
      "userName": "Jex Alaric",
      "userType": "USER"
    },
    {
      "uid": "7c73cd0a-d72c-4d7e-808b-366094ce7b98",
      "userName": "Kaelis Dronyx",
      "userType": "USER"
    },
    {
      "uid": "79c3abef-eefb-4542-8ae2-364e6c78696f",
      "userName": "Miraen Solis",
      "userType": "USER"
    },
    {
      "uid": "2f24647f-ec6b-4fc9-8ac6-e9edfd4ef004",
      "userName": "Nexari Prime",
      "userType": "USER"
    },
    {
      "uid": "45c3abed-eefb-4562-8ad2-364e6c78696f",
      "userName": "Nina Takahashi",
      "userType": "USER"
    },
    {
      "uid": "22b0ae2d-d4e4-47eb-900a-fb6f76e655e7",
      "userName": "Robert Vexley",
      "userType": "USER"
    },
    {
      "uid": "f39b4983-256e-4643-adec-9f0d5da09ab7",
      "userName": "Vorrik Senn",
      "userType": "USER"
    }
  ],
  "message": "List of company User Name and UID / Api Key name and Client Id",
  "terms": "This data is subject to the Acceptable Use Policy https://www.megaport.com/legal/acceptable-use-policy"
}

Returns a list of users who have performed activities within the logged-in user’s company, sorted alphabetically by userName.

The response contains the uid, userName, and userType for every user that has recorded an activity.

The uid and userName show the user ID and user name, or API key (Client Id) and API key name, depending on the type of user.

The userType value can be one of the following:

USER
STAFF
API
M2M
SYSTEM

For example:

“uid”: “7c73cd0a-d72c-4d7e-808b-366094ce7b98”,
“userName”: “Kaelis Dronyx”,
“userType”: “USER”

For a full list of the activities that are recorded, see What information is logged.

Who can view activities?

Company Admins can retrieve all of the activities of the company the user belongs to using this request. However, the same request by a user who is not a Company Admin will return an error with the message “Missing the required permission [company_admin]”. The same result is returned if a Company Admin attempts to access a different companies’ activities.

Response

Company Activity By User / Company Activity By User

datalist of objectsOptional

messagestringOptional

termsstringOptional