Invite Admin User

Send invitation to an admin user

`This endpoint allows you to invite a member to manage the Admin account

Features and their respective permissions are as below:

  • my_plan:
    • "all"
  • api:
    • "none"
  • user_management:
    • "all"
  • app_management | Not available in ENTv2:
    • "all"

Note:

  • If all_features_access: false then only privileges are required otherwise if true then it's assumed that all permissions will be there for the invited admin user.

Options

Body
Payload to send an invitation

Request body which must comply to the following JSON Schema:

{
  "required" : [ "all_features_access", "email", "privileges" ],
  "type" : "object",
  "properties" : {
    "email" : {
      "type" : "string",
      "description" : "Email address for the organization",
      "format" : "email",
      "example" : "inviteuser@example.com"
    },
    "all_features_access" : {
      "type" : "boolean",
      "description" : "All access to the features",
      "example" : true,
      "enum" : [ true, false ]
    },
    "groupIds" : {
      "type" : "array",
      "description" : "Ids of Group",
      "example" : [ "2baxxxxxxxxxxxxxxxxxxxxxcaa", "65axxxxxxxxxxxxxxxxxxxxxc5a" ],
      "items" : {
        "type" : "string",
        "description" : "Group Id"
      }
    },
    "privileges" : {
      "type" : "array",
      "items" : {
        "type" : "object",
        "properties" : {
          "feature" : {
            "type" : "string",
            "description" : "Feature name",
            "example" : "user_management",
            "enum" : [ "my_plan", "api", "user_management", "app_management" ]
          },
          "permissions" : {
            "type" : "array",
            "description" : "Permissions for a given feature",
            "items" : {
              "type" : "string",
              "example" : "'all', 'none'",
              "enum" : [ "all", "none" ]
            }
          }
        },
        "description" : "Privileges given to the user",
        "example" : [ {
          "feature" : "my_plan",
          "permissions" : [ "all" ]
        }, {
          "feature" : "api",
          "permissions" : [ "none" ]
        } ]
      }
    }
  }
}
Result Format

Specify how the response should be mapped to the table output. The following formats are available:

Raw Response: Returns the raw response in a single row with the following columns:

  • body: Response body
  • status: HTTP status code

Input Ports

Icon
Configuration data.

Output Ports

Icon
Result of the request depending on the selected Result Format.
Icon
Configuration data (this is the same as the input port; it is provided as passthrough for sequentially chaining nodes to declutter your workflow connections).

Popular Predecessors

  • No recommendations found

Popular Successors

  • No recommendations found

Views

This node has no views

Workflows

  • No workflows found

Links

Developers

You want to see the source code for this node? Click the following button and we’ll use our super-powers to find it for you.

Installation

To use this node in KNIME, install the extension Brevo from the below update site following our NodePit Product and Node Installation Guide:

v5.3

A zipped version of the software site can be downloaded here.

Plugin provider: NodePit
Plugin version: 1.0.1.202407051339
On NodePit since: 2024-07-09
Last update: 2024-11-21
KNIME versions: Since v4.7
NodePit Exclusive Only available on NodePit

Deploy, schedule, execute, and monitor your KNIME workflows locally, in the cloud or on-premises – with our brand new NodePit Runner.

Try NodePit Runner!