Add member to group

Adds a member to a workspace group. Members may need to be approved, so an action is returned from this request. The action can be used to track the progress of the approval, if required.

Authorization

authorization<token>

Use your API key here.

In: header

Request Body

application/jsonRequired

Request body for inviting a member to a group.

emailRequiredstring

The email of the user to invite

Format: "email"

roleRequiredstring

Role of the user in the group

Value in: "STANDARD" | "ADMIN"

Path Parameters

group_idRequiredstring

An alternate shortcut for specifying subaccounts. Can be used in place of subaccount_names

Format: "uuid"

curl -X POST "https://app.luxor.tech/api/v1/workspace/groups/497f6eca-6276-4993-bfeb-53cbbbba6f08/members" \
  -H "authorization: <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "email": "user@luxor.tech",
    "role": "ADMIN"
  }'

Response with the invite member action created

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "actionName": "DISABLE_ADMIN_APPROVAL_FLOW",
  "status": "PROCESSING",
  "initiatedAt": "2019-08-24T14:15:22Z",
  "initiatedBy": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "displayName": "string",
    "type": "API_KEY"
  },
  "requiresApproval": true,
  "canceledBy": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "displayName": "string",
    "type": "API_KEY"
  },
  "approvedAt": "2019-08-24T14:15:22Z",
  "rejectedAt": "2019-08-24T14:15:22Z",
  "approvedBy": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "displayName": "string",
      "type": "API_KEY"
    }
  ],
  "rejectedBy": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "displayName": "string",
      "type": "API_KEY"
    }
  ],
  "url": "/v1/api/workspace/actions/0123456a-bc78-901d-efg2-h345ij6k78lm",
  "metadata": null
}

Add member to group

Authorization

Request Body

Path Parameters

Response

TypeScript