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

Revoke takes one subject's own grants off many servers, the servers by id or by tag. Like Grant it is one transaction and one access change.

nokku.v1.TargetAccountService
POST
https://app.nokku.sh/nokku.v1.TargetAccountService/Revoke
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.RevokeRequest
revoke
objectRequired

Whose grants go where. A server counts when its id is named or it has one of the tags. Only the subject's own grants go, what a team gives its members stays.

subject
objectRequired
id?
string <uuid>
kind?
string
Enum:"SUBJECT_KIND_UNSPECIFIED""SUBJECT_KIND_USER""SUBJECT_KIND_TEAM""SUBJECT_KIND_SERVICE_ACCOUNT"
targetIds?
array<string>
tags?
array<string>

Responses

200

Success

application/json

nokku.v1.RevokeResponse
plan?
object

What it did.

grants?
integer <int32>

Grants that go, one per account and server.

servers?
integer <int32>

Servers they are on.

accounts?
array<nokku.v1.RevokeAccount>

The accounts, the one on the most servers first.

otherTags?
integer <int32>

Servers among them with more than one tag. The access goes for those tags too.

otherTagNames?
array<string>

Some of their names.

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/Revoke' \
  -H 'Authorization: Bearer <token>' \
  -H 'Content-Type: application/json' \
  -d '{
  "revoke": {
    "subject": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "kind": "SUBJECT_KIND_UNSPECIFIED"
    },
    "targetIds": [
      "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    ],
    "tags": [
      "string"
    ]
  }
}'

Example Responses

{
  "plan": {
    "grants": 0,
    "servers": 0,
    "accounts": [
      {
        "username": "string",
        "servers": 0,
        "serverNames": [
          "string"
        ]
      }
    ],
    "otherTags": 0,
    "otherTagNames": [
      "string"
    ]
  }
}