List group users

Returns a list of users that belong to a group.

Path Parameters

org_id string required
id string required

Query Parameters

with_roles boolean

Responses

• 200
• 400
• 401
• 403
• 404
• 500
• default

---

A successful response.

application/json

Schema

Example (from schema)

---

Schema

users object[]
Array [
id string
name can either be empty or must start with a character
Unique name of the user.
title string
Name of the user.
email string
metadata object
created_at date-time
The time the user was created.
updated_at date-time
The time the user was last updated.
state string
The state of the user (enabled or disabled).
avatar string
The base64 encoded image string of the user avatar. Should be less than 2MB.
]
role_pairs object[]
Array [
user_id string
roles object[]
Array [
id string
name string
permissions string[]
title string
metadata object
created_at date-time
The time the role was created.
updated_at date-time
The time the role was last updated.
org_id string
state string
scopes string[]
]
]

{
  "users": [
    {
      "id": "string",
      "name": "johndoe",
      "title": "John Doe",
      "email": "string",
      "metadata": {},
      "created_at": "2023-06-07T05:39:56.961Z",
      "updated_at": "2023-06-07T05:39:56.961Z",
      "state": "enabled",
      "avatar": "string"
    }
  ],
  "role_pairs": [
    {
      "user_id": "string",
      "roles": [
        {
          "id": "string",
          "name": "string",
          "permissions": [
            "string"
          ],
          "title": "string",
          "metadata": {},
          "created_at": "2023-06-07T05:39:56.961Z",
          "updated_at": "2023-06-07T05:39:56.961Z",
          "org_id": "string",
          "state": "string",
          "scopes": [
            "string"
          ]
        }
      ]
    }
  ]
}

Bad Request - The request was malformed or contained invalid parameters.

application/json

Schema

Example (from schema)

---

Schema

code int32
message string
details object[]
Array [
@type string
]

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

Unauthorized - Authentication is required

application/json

Schema

Example (from schema)

---

Schema

code int32
message string
details object[]
Array [
@type string
]

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

Forbidden - User does not have permission to access the resource

application/json

Schema

Example (from schema)

---

Schema

code int32
message string
details object[]
Array [
@type string
]

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

Not Found - The requested resource was not found

application/json

Schema

Example (from schema)

---

Schema

code int32
message string
details object[]
Array [
@type string
]

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

Internal Server Error. Returned when theres is something wrong with Frontier server.

application/json

Schema

Example (from schema)

---

Schema

code int32
message string
details object[]
Array [
@type string
]

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

An unexpected error response.

application/json

Schema

Example (from schema)

---

Schema

code int32
message string
details object[]
Array [
@type string
]

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

Loading...