Get Group

GET 
/v2/group/:group_id

Get a group by group ID.Requires accountOrg:config:view or account:config:view permissions and for user to be in the same org as the group

Request

Path Parameters

group_id uuidrequired

Group ID

Responses

200

Successful Response

application/json

Schema

Schema

org_group_name Org Group Name (string)

Name of the organization group

org_id uuidrequired

Organization ID for this group

description Description (string)

Description for this group

group_id uuidrequired

ID of the group

Example (from schema)

{
  "org_group_name": "string",
  "org_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "description": "string",
  "group_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}

422

Validation Error

application/json

Schema

Schema

detail

object[]

Array [

loc

object[]

required

Array [

anyOf

MOD1

string

MOD2

integer

]

msg Message (string)required

type Error Type (string)required

]

Example (from schema)

{
  "detail": [
    {
      "loc": [
        "string",
        0
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Loading...