Skip to navigation
Accounts and SettingsMaster Account

Send invitation to an admin user

View as Markdown

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”
  • sub_organization_groups
    • “create”
    • “edit_delete”
  • create_sub_organizations
    • “all”
  • manage_sub_organizations
    • “all”
  • analytics
    • “download_data”
    • “create_alerts”
    • “my_looks”
    • “explore_create”
  • security
    • “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.

Authentication

api-keystring

The API key should be passed in the request headers as api-key for authentication.

OR
AuthorizationBearer

OAuth 2.0 client_credentials (machine-to-machine) grant. Exchange your app’s client_id/client_secret for a short-lived Bearer token.

Request

Payload to send an invitation
all_features_accessbooleanRequired
All access to the features
emailstringRequiredformat: "email"
Email address for the organization
privilegeslist of objectsRequired
groupIdslist of stringsOptional
Ids of Group

Response

Invitation ID
idstringOptional

Errors

400
Bad Request Error