Add Member (POST)
  • 01 Aug 2023
  • 1 Minute to read
  • Contributors

    Add Member (POST)


      Article Summary

      POST /v1/groups/{groupId}/member/{userId}

      Add a member to a group.

      Parameters:

      PropertyData TypeDescription
      groupId*StringID of group.
      userId*StringID of user.

      Request Body: None

      Request Example:

      curl -X POST 'https://api.perimeter81.com/api/rest/v1/groups/<GROUP_ID>/member/<USER_ID>' -H 'Authorization: Bearer <ACCESS_TOKEN>'

      Response:

      Status CodeMessage/Response BodyDescription
      201GroupSuccess. Group member added.

      Response Example:

      {
        "tenantId":"<TENANT_NAME>",
        "name":"<GROUP_NAME>",
        "description":"<GROUP_DESCRIPTION>",
        "isDefault":false,
        "applications":[],
        "networks":[],
        "vpnLocations":[],
        "users":[
          "<USER1_ID>",
          "<USER2_ID>",
          "<USER3_ID"
        ],
        "createdAt":"2020-03-05T17:04:38.946Z",
        "updatedAt":"2021-09-30T14:03:30.947Z",
        "id":"<GROUP_ID>"
      }

      Was this article helpful?