List Users in Group

GET 
/org/:orgId/groups/:groupId/users

Get the list of users that exist in this group

Request

Path Parameters

orgId stringrequired

The Organization ID (UUID) for which you are querying.

groupId stringrequired

The Group ID (UUID) for which you are querying.

Responses

200

Success.

application/json

Schema

Schema

any

Example (from schema)

{
  "status": {
    "i18n_message": "response.ok",
    "message": "OK"
  },
  "response": {
    "users": [
      {
        "user_id": "e381667f-8049-46f6-4916-e5b8a93ffe87",
        "name": "Kristi Long",
        "email": "kristi@atscale.com",
        "auth_username": "kristi@atscale.com",
        "super_user": true,
        "api_super_user": false,
        "session_password": ""
      },
      {
        "user_id": "27354c24-f5b8-4fbb-6e82-58a8b67b12c5",
        "name": "Mike Aldrich",
        "email": "mike@atscale.com",
        "auth_username": "mike@atscale.com",
        "super_user": false,
        "api_super_user": false,
        "session_password": ""
      },
      {
        "user_id": "49d46e42-ced3-4fe1-41da-62a486791416",
        "name": "Rafael Lopez",
        "email": "rafael@atscale.com",
        "auth_username": "rafael@atscale.com",
        "super_user": true,
        "api_super_user": false,
        "session_password": ""
      },
      {
        "user_id": "c8aec429-0218-45af-5704-413406f43232",
        "name": "Shanti Chand",
        "email": "shanti@atscale.com",
        "auth_username": "shanti@atscale.com",
        "super_user": true,
        "api_super_user": false,
        "session_password": ""
      }
    ]
  }
}

Example

{
  "status": {
    "i18n_message": "response.ok",
    "message": "OK"
  },
  "response": {
    "users": [
      {
        "user_id": "e381667f-8049-46f6-4916-e5b8a93ffe87",
        "name": "Kristi Long",
        "email": "kristi@atscale.com",
        "auth_username": "kristi@atscale.com",
        "super_user": true,
        "api_super_user": false,
        "session_password": ""
      },
      {
        "user_id": "27354c24-f5b8-4fbb-6e82-58a8b67b12c5",
        "name": "Mike Aldrich",
        "email": "mike@atscale.com",
        "auth_username": "mike@atscale.com",
        "super_user": false,
        "api_super_user": false,
        "session_password": ""
      },
      {
        "user_id": "49d46e42-ced3-4fe1-41da-62a486791416",
        "name": "Rafael Lopez",
        "email": "rafael@atscale.com",
        "auth_username": "rafael@atscale.com",
        "super_user": true,
        "api_super_user": false,
        "session_password": ""
      },
      {
        "user_id": "c8aec429-0218-45af-5704-413406f43232",
        "name": "Shanti Chand",
        "email": "shanti@atscale.com",
        "auth_username": "shanti@atscale.com",
        "super_user": true,
        "api_super_user": false,
        "session_password": ""
      }
    ]
  }
}

401

This error will occur if calling user does not have access right for the API.

404

This error will occur if the org identified by orgId does not exist.

500

A server error occurred. Check the logs for more details.

Loading...