Sign in
local-groups

update local group information

Changed on
<h3>Administrator updates the local group information.</h3>
patch/local-groups/{group_id}

Request

  • Base URL: /api/v1 (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/v1/local-groups/{group_id}
  • Auth: API key in header Authorization

Path parameters

group_idstring text required

id of the local group

Request body

descriptionstring text required

description for the LocalGroup

Example request

{
  "name": "This is an awesome local group!"
}

Response

local group modified

idstring text

unique identifier

codestring text required

group code

descriptionstring text required

group description

client_idstring text

<instance_id>:<member_class>:<member_code>:<subsystem>(optional)

member_countinteger

member count

updated_atstring date-time

last time updated

Example response

{
  "code": "groupcode",
  "description": "description",
  "client_id": "FI:GOV:123:ABC",
  "member_count": 10,
  "updated_at": "2018-12-15T00:00:00.001Z",
  "members": [
    {
      "id": "FI:GOV:123",
      "member_name": "Member123",
      "subsystem_name": "Subsystem123",
      "created_at": "2018-12-15T00:00:00.001Z"
    }
  ]
}

Changes

  • 26d051d8c39eRevision changes
    • ○

      added the optional property to the response with the status

  • 86ab791a2584Revision changes
    • ▲

      added the pattern ^[a-zA-Z0-9-_,.;:!? ]*$ to the request property

    • ●

      removed the optional property from the response with the status