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

Grant gives subjects one account on many servers, the servers by id or by tag. It is one transaction and one access change, however many servers.

nokku.v1.TargetAccountService
POST
https://app.nokku.sh/nokku.v1.TargetAccountService/Grant
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.GrantRequest
grant
objectRequired

Who gets which account where. A server counts when its id is named or it has one of the tags.

subjects?
array<nokku.v1.GrantSubject>
targetIds?
array<string>
tags?
array<string>
username?
string

Empty asks only which servers these are and what accounts they have.

expiresAt?
string <date-time>

Unset is for good.

changeEnds?
boolean

A grant that stands with another end keeps it, unless this is set.

Responses

200

Success

application/json

nokku.v1.GrantResponse
plan?
object

What it did.

servers?
integer <int32>

Servers the ids and tags name.

serverNames?
array<string>

Some of their names, to show which they are.

accounts?
array<nokku.v1.GrantAccount>

The accounts those servers have, the most common first.

withAccount?
integer <int32>

Servers that have the account asked for.

skipped?
array<string>

Some of the servers that lack it. Nothing happens there.

outcomes?
array<nokku.v1.GrantOutcome>
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.TargetAccountService/Grant' \
  -H 'Authorization: Bearer <token>' \
  -H 'Content-Type: application/json' \
  -d '{
  "grant": {
    "subjects": [
      {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "kind": "SUBJECT_KIND_UNSPECIFIED"
      }
    ],
    "targetIds": [
      "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    ],
    "tags": [
      "string"
    ],
    "username": "string",
    "expiresAt": "2023-01-15T01:30:15.01Z",
    "changeEnds": true
  }
}'

Example Responses

{
  "plan": {
    "servers": 0,
    "serverNames": [
      "string"
    ],
    "accounts": [
      {
        "username": "string",
        "servers": 0
      }
    ],
    "withAccount": 0,
    "skipped": [
      "string"
    ],
    "outcomes": [
      {
        "subjectId": "string",
        "added": 0,
        "same": 0,
        "otherEnd": 0
      }
    ]
  }
}