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

GetAccessMatrix is who reaches which tag, a page of rows at a time and only the cells that hold access.

nokku.v1.TargetService
POST
https://app.nokku.sh/nokku.v1.TargetService/GetAccessMatrix
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.GetAccessMatrixRequest
query?
string

query matches the name or email of a row.

kind?
string

kind keeps only people, teams or service accounts.

Enum:"SUBJECT_KIND_UNSPECIFIED""SUBJECT_KIND_USER""SUBJECT_KIND_TEAM""SUBJECT_KIND_SERVICE_ACCOUNT"
tags?
array<string>

tags are the columns, the biggest ones when empty. An empty tag is the servers with none.

limit?
integer <int32>
offset?
integer <int32>

Responses

200

Success

application/json

nokku.v1.GetAccessMatrixResponse
columns?
array<nokku.v1.AccessGraphTag>

columns are the tags the cells are for, in order.

rows?
array<nokku.v1.AccessMatrixRow>
total?
integer <int32>

total counts every row that matches, not only this page.

tags?
array<nokku.v1.AccessGraphTag>

tags is every tag with its servers, to pick other columns from.

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.TargetService/GetAccessMatrix' \
  -H 'Authorization: Bearer <token>' \
  -H 'Content-Type: application/json' \
  -d '{
  "query": "string",
  "kind": "SUBJECT_KIND_UNSPECIFIED",
  "tags": [
    "string"
  ],
  "limit": 1,
  "offset": 0
}'

Example Responses

{
  "columns": [
    {
      "tag": "string",
      "targets": 0,
      "total": 0
    }
  ],
  "rows": [
    {
      "subjectId": "string",
      "kind": "SUBJECT_KIND_UNSPECIFIED",
      "name": "string",
      "email": "string",
      "memberCount": 0,
      "targets": 0,
      "cells": [
        {
          "tag": "string",
          "targets": 0,
          "usernames": [
            "string"
          ],
          "expiresAt": "2023-01-15T01:30:15.01Z",
          "lastUsedAt": "2023-01-15T01:30:15.01Z"
        }
      ]
    }
  ],
  "total": 0,
  "tags": [
    {
      "tag": "string",
      "targets": 0,
      "total": 0
    }
  ]
}