Create an invite

Management API · User Management

POST https://app.mk.io/api/v1/organization/invites

This endpoint allows you to create a new invitation which will grant a user access to this organization's resources within MK.IO.

You can include a comment which will be visible against this user's record when they accept the invitation, e.g. "Contractor for project Delphi".

RBAC Capability Required: core.invite.create

Authentication

• Authorization header — Bearer authentication of the form Bearer <token>.

Request body

Content type: application/json

• spec · object · Required — Specification
  • comment · string · Required — Comment to explain why the user has been invited to collaborate with your organization
  • email · string · Required — Email of the user to be invited
  • teams · list of strings · Optional — List of team names to add this user to when they accept.
    • Array items (string):

Example request

curl -X POST "https://app.mk.io/api/v1/organization/invites" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
  "spec": {
    "comment": "string",
    "email": "string",
    "teams": [
      "string"
    ]
  }
}'

Responses

201 — OK

• kind · string · Optional — The kind of record.
• metadata · object · Optional — Metadata
  • created · string · Optional · format: date-time — The time when the resource was created
  • id · string · Required · format: uuid — The ID of the resource
• spec · object · Required — Specification
  • comment · string · Required — Comment to explain why the user has been invited to collaborate with your organization
  • email · string · Required — Email of the user to be invited
  • invitedByEmail · string · Required — Contact email of user who made the invite
  • invitedByName · string · Required — Name of user who made the invite
  • organizationName · string · Required — Name of the organization the invite refers to
  • teams · list of strings · Optional — List of team names to add this user to when they accept.
    • Array items (string):

400 — Bad Request

• error · object · Required — Pertinent information about the error
  • code · string · Required — The error code.
  • detail · string · Required — The error message.
  • extraDetail · map from strings to any · Optional — Extra information regarding this error.
    • [any key] · any — map of additional properties
• ref · string · Required — A reference to the request that caused the error.
• status · integer · Required — The HTTP status code

401 — Unauthorized

403 — Forbidden

404 — Not Found

409 — Conflict

429 — Too Many Requests

500 — Internal Server Error