List organization groups

Get all groups that belong to an organization. The results can be filtered by state which can be either be enabled or disabled.

Path Parameters

org_id string required

Query Parameters

state string

The state of the group to filter by. It can be enabled or disabled.

group_ids string[]
with_members boolean
with_member_count boolean

Responses

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

---

A successful response.

application/json

Schema

Example (from schema)

---

Schema

groups object[]
Array [
id string
name string
title string
org_id string
metadata object
created_at date-time
The time the group was created.
updated_at date-time
The time the group was last updated.
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.
]
members_count int32
The number of members explicitly added in the project.
]

{
  "groups": [
    {
      "id": "string",
      "name": "string",
      "title": "string",
      "org_id": "string",
      "metadata": {},
      "created_at": "2023-06-07T05:39:56.961Z",
      "updated_at": "2023-06-07T05:39:56.961Z",
      "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"
        }
      ],
      "members_count": 2
    }
  ]
}

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"
    }
  ]
}

GET /v1beta1/organizations/:org_id/groups

Authorization

name: Basic type: httpdescription: use Client ID as username and Client Secret as passwordin: headerscheme: basic

Request

Base URL

http://127.0.0.1:7400

Security Scheme

BasicBearer

Username

Password

org_id — path required

state — query

group_ids — query

with_members — query

---truefalse

with_member_count — query

---truefalse

curl / cURL

curl -L -X GET 'http://127.0.0.1:7400/v1beta1/organizations/:org_id/groups' \
-H 'Accept: application/json'

python / requests

curl -L -X GET 'http://127.0.0.1:7400/v1beta1/organizations/:org_id/groups' \
-H 'Accept: application/json'

go / native

curl -L -X GET 'http://127.0.0.1:7400/v1beta1/organizations/:org_id/groups' \
-H 'Accept: application/json'

nodejs / axios

curl -L -X GET 'http://127.0.0.1:7400/v1beta1/organizations/:org_id/groups' \
-H 'Accept: application/json'

ruby / Net::HTTP

curl -L -X GET 'http://127.0.0.1:7400/v1beta1/organizations/:org_id/groups' \
-H 'Accept: application/json'

csharp / RestSharp

curl -L -X GET 'http://127.0.0.1:7400/v1beta1/organizations/:org_id/groups' \
-H 'Accept: application/json'

php / cURL

curl -L -X GET 'http://127.0.0.1:7400/v1beta1/organizations/:org_id/groups' \
-H 'Accept: application/json'

java / OkHttp

curl -L -X GET 'http://127.0.0.1:7400/v1beta1/organizations/:org_id/groups' \
-H 'Accept: application/json'

powershell / RestMethod

curl -L -X GET 'http://127.0.0.1:7400/v1beta1/organizations/:org_id/groups' \
-H 'Accept: application/json'