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

CreateJoinToken

nokku.v1.JoinTokenService
POST
https://app.nokku.sh/nokku.v1.JoinTokenService/CreateJoinToken
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.CreateJoinTokenRequest
label?
string
ttl?
string

duration.gt = 0s

maxUses?
integer <int32>
autoApprove?
boolean
tags?
array<string>
grants?
array<nokku.v1.JoinTokenGrant>
ephemeral?
boolean
retireAfter?
string

duration.gte = 60s duration.lte = 604800s

Responses

200

Success

application/json

nokku.v1.CreateJoinTokenResponse
token?
object
id?
string
label?
string
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.

maxUses?
integer <int32>
uses?
integer <int32>
autoApprove?
boolean
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.

lastUsedAt?
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.

tags?
array<string>
grants?
array<nokku.v1.JoinTokenGrant>
ephemeral?
boolean
retireAfter?
string

A signed duration in seconds, with up to nine fractional digits and an `s` suffix (for example, `3s` or `-0.001s`).

secret?
string
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.JoinTokenService/CreateJoinToken' \
  -H 'Authorization: Bearer <token>' \
  -H 'Content-Type: application/json' \
  -d '{
  "label": "string",
  "ttl": "string",
  "maxUses": 1,
  "autoApprove": true,
  "tags": [
    "string"
  ],
  "grants": [
    {
      "username": "string",
      "userIds": [
        "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      ],
      "teamIds": [
        "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      ],
      "serviceAccountIds": [
        "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      ]
    }
  ],
  "ephemeral": true,
  "retireAfter": "string"
}'

Example Responses

{
  "token": {
    "id": "string",
    "label": "string",
    "expiresAt": "2023-01-15T01:30:15.01Z",
    "maxUses": 0,
    "uses": 0,
    "autoApprove": true,
    "createdAt": "2023-01-15T01:30:15.01Z",
    "lastUsedAt": "2023-01-15T01:30:15.01Z",
    "tags": [
      "string"
    ],
    "grants": [
      {
        "username": "string",
        "userIds": [
          "497f6eca-6276-4993-bfeb-53cbbbba6f08"
        ],
        "teamIds": [
          "497f6eca-6276-4993-bfeb-53cbbbba6f08"
        ],
        "serviceAccountIds": [
          "497f6eca-6276-4993-bfeb-53cbbbba6f08"
        ]
      }
    ],
    "ephemeral": true,
    "retireAfter": "string"
  },
  "secret": "string"
}