Invite 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

Views

This node has no views

Workflows

• No workflows found

Links

• No links available

Developers