launchdarkly · Schema

MemberInviteBody

The request body for inviting a new member.

Properties

Name Type Description
email string The email address of the person to invite.
role string The built-in role to assign.
customRoles array Custom role keys to assign to the new member.
View JSON Schema on GitHub

JSON Schema

launchdarkly-memberinvitebody-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/MemberInviteBody",
  "title": "MemberInviteBody",
  "type": "object",
  "description": "The request body for inviting a new member.",
  "required": [
    "email"
  ],
  "properties": {
    "email": {
      "type": "string",
      "format": "email",
      "description": "The email address of the person to invite."
    },
    "role": {
      "type": "string",
      "description": "The built-in role to assign.",
      "enum": [
        "reader",
        "writer",
        "admin"
      ]
    },
    "customRoles": {
      "type": "array",
      "description": "Custom role keys to assign to the new member.",
      "items": {
        "type": "string"
      }
    }
  }
}