Create Team Membership

v1.0.0

Use this endpoint to invite a new member to join your team. If initiated from Client SDK, an email with a link to join the team will be sent to the new member's email address if the member doesn't exist in the project it will be created automatically. If initiated from server side SDKs, new member will automatically be added to the team.

Use the 'URL' parameter to redirect the user from the invitation email back to your app. When the user is redirected, use the endpoint to allow the user to accept the invitation to the team. While calling from side SDKs the redirect url can be empty string.

Please note that in order to avoid a the only valid redirect URL's are the once from domains you have set when added your platforms in the console interface.

Input

{
  "type": "object",
  "properties": {
    "email": {
      "type": "string",
      "description": "New team member email."
    },
    "name": {
      "type": "string",
      "description": "New team member name. Max length: 128 chars."
    },
    "roles": {
      "type": "array",
      "description": "Array of strings. Use this param to set the user roles in the team. A role can be any string. Learn more about [roles and permissions](/docs/permissions). Max length for each role is 32 chars.",
      "items": {
        "type": "string"
      }
    },
    "teamId": {
      "type": "string"
    },
    "url": {
      "type": "string",
      "description": "URL to redirect the user back to your app from the invitation email.  Only URLs from hostnames in your project platform list are allowed. This requirement helps to prevent an [open redirect](https://cheatsheetseries.owasp.org/cheatsheets/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.html) attack against your project API."
    }
  },
  "required": [
    "email",
    "roles",
    "teamId",
    "url"
  ],
  "additionalProperties": false
}

Output

{
  "type": "object",
  "description": "Membership",
  "required": [
    "$id",
    "confirm",
    "email",
    "invited",
    "joined",
    "name",
    "roles",
    "teamId",
    "userId"
  ],
  "properties": {
    "$id": {
      "type": "string",
      "description": "Membership ID."
    },
    "confirm": {
      "type": "boolean",
      "description": "User confirmation status, true if the user has joined the team or false otherwise."
    },
    "email": {
      "type": "string",
      "description": "User email address."
    },
    "invited": {
      "type": "integer",
      "format": "int32",
      "description": "Date, the user has been invited to join the team in Unix timestamp."
    },
    "joined": {
      "type": "integer",
      "format": "int32",
      "description": "Date, the user has accepted the invitation to join the team in Unix timestamp."
    },
    "name": {
      "type": "string",
      "description": "User name."
    },
    "roles": {
      "type": "array",
      "description": "User list of roles",
      "items": {
        "type": "string"
      }
    },
    "teamId": {
      "type": "string",
      "description": "Team ID."
    },
    "userId": {
      "type": "string",
      "description": "User ID."
    }
  }
}