Update Org Group

PUT 
/v1/permissions-org-group/:org_identifier

Update an Org Group, requires permissionsOrgGroup:config:edit | portalPermissions:config:edit permission

Request

Path Parameters

org_identifier anyrequired

Organization ID or short name

application/json

Body

required

group_id uuidrequired
org_group_name Org Group Name (string)required
org_id uuidrequired
display_name Display Name (string)
description Description (string)

Responses

200

Successful Response

application/json

Schema

Schema

group_id uuidrequired
org_group_name Org Group Name (string)required
org_id uuidrequired
display_name Display Name (string)
description Description (string)

Example (from schema)

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

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...