Skip to content
Nokku LogoNokku
API Referencev1.0.0 · 174 endpoints

CreateInvitation

nokku.v1.InvitationService
POST
https://app.nokku.sh/nokku.v1.InvitationService/CreateInvitation
Try it
Authorization (BearerAuth)

Header Parameters

Connect-Protocol-Version?number

Define the version of the Connect protocol

Example 1
Connect-Timeout-Ms?number

Define the timeout, in ms

Example 1000

Authorization

  • BearerAuth (bearer)

    A service account token. Include it in the Authorization header: `Authorization: Bearer <token>`

  • CookieAuth (cookie: __Host-nokku_session)

    The session cookie the web app uses. Browsers send it after sign-in. Only on `localhost` it is named `nokku_session`.

Request Body

Required

application/json

nokku.v1.CreateInvitationRequest
email?
string <email>
role?
string

No role is a member. The owner is never invited.

Enum:"WORKSPACE_ROLE_UNSPECIFIED""WORKSPACE_ROLE_MEMBER""WORKSPACE_ROLE_VIEWER""WORKSPACE_ROLE_EDITOR""WORKSPACE_ROLE_ADMIN"

Responses

200

Success

application/json

nokku.v1.CreateInvitationResponse
invitation?
object
email?
string
role?
string
Enum:"WORKSPACE_ROLE_UNSPECIFIED""WORKSPACE_ROLE_MEMBER""WORKSPACE_ROLE_VIEWER""WORKSPACE_ROLE_EDITOR""WORKSPACE_ROLE_ADMIN""WORKSPACE_ROLE_OWNER"
expiresAt?
string <date-time>

A point in time in RFC 3339 format, with up to nanosecond precision. Output uses UTC (`Z`); input may use an offset from UTC.

createdAt?
string <date-time>

A point in time in RFC 3339 format, with up to nanosecond precision. Output uses UTC (`Z`); input may use an offset from UTC.

link?
string

Set only when the server sends no mail.

default

Error

application/json

connect.error

Error type returned by Connect: https://connectrpc.com/docs/go/errors/#http-representation

code?
string

The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].

Enum:"canceled""unknown""invalid_argument""deadline_exceeded""not_found""already_exists""permission_denied""resource_exhausted""failed_precondition""aborted""out_of_range""unimplemented""internal""unavailable""data_loss""unauthenticated"
message?
string

A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.

details?
array<connect.error_details.Any>

A list of messages that carry the error details. There is no limit on the number of messages.

Code Samples

curl -X POST 'https://app.nokku.sh/nokku.v1.InvitationService/CreateInvitation' \
  -H 'Authorization: Bearer <token>' \
  -H 'Content-Type: application/json' \
  -d '{
  "email": "user@example.com",
  "role": "WORKSPACE_ROLE_UNSPECIFIED"
}'

Example Responses

{
  "invitation": {
    "email": "string",
    "role": "WORKSPACE_ROLE_UNSPECIFIED",
    "expiresAt": "2023-01-15T01:30:15.01Z",
    "createdAt": "2023-01-15T01:30:15.01Z"
  },
  "link": "string"
}