List user groups

Lists all the groups a user belongs to across all organization in Frontier. To get the groups of a user in a specific organization, use the org_id filter in the query parameter.

Path Parameters

id string required

The unique ID of the user to get groups for.

Query Parameters

orgId string

The organization ID to filter groups by. If not provided, groups from all organizations are returned.

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
orgId string
metadata object
createdAt date-time
The time the group was created.
updatedAt date-time
The time the group was last updated.
]

{
  "groups": [
    {
      "id": "string",
      "name": "string",
      "title": "string",
      "orgId": "string",
      "metadata": {},
      "createdAt": "2023-06-07T05:39:56.961Z",
      "updatedAt": "2023-06-07T05:39:56.961Z"
    }
  ]
}

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/users/: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

id — path required

orgId — query

curl / cURL

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

python / requests

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

go / native

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

nodejs / axios

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

ruby / Net::HTTP

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

csharp / RestSharp

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

php / cURL

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

java / OkHttp

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

powershell / RestMethod

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