Sign in
local-groups

add new member for the local group

<h3>Administrator adds a new member for the local group.</h3> <p>The new member can be an X-Road member or a subsystem.</p>
post/local-groups/{group_id}/members

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}/members
  • Auth: API key in header Authorization

Path parameters

group_idstring text required

id of the local group

Request body

itemsstring[]

array of members to be added

Example request

{
  "items": [
    "FI:GOV:123",
    "FI:GOV:123:SS1",
    "FI:GOV:123:SS2"
  ]
}

Response

new members added

itemsstring[]

array of members to be added

Example response

{
  "items": [
    "FI:GOV:123",
    "FI:GOV:123:SS1",
    "FI:GOV:123:SS2"
  ]
}

Changes

No recorded changes to this operation across all 50 revisions of this API.