# GetSubjectAccess

`POST /nokku.v1.TargetService/GetSubjectAccess`

GetSubjectAccess

Base URL: https://app.nokku.sh

## Authorization

- BearerAuth: HTTP bearer
- CookieAuth: API key in cookie `__Host-nokku_session`

## Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `Connect-Protocol-Version` | header | number | no | Define the version of the Connect protocol |
| `Connect-Timeout-Ms` | header | number | no | Define the timeout, in ms |

## Request body (application/json, required)

- `subjectId` (string)

Example:

```json
{
  "subjectId": "68460e63-0717-47f9-8fd8-d28f152cb30b"
}
```

## Responses

### 200: Success

Returns `nokku.v1.GetSubjectAccessResponse`.

- `targets` (array<nokku.v1.Target>)
- `daemons` (array<nokku.v1.Daemon>)
- `certificateAuthority` (object): certificate_authority is the workspace's, for a subject with targets to log in to.
  - `id` (string)
  - `userPublicKey` (string)
  - `hostPublicKey` (string)
  - `rotatedAt` (string): Unset until the first rollover.
  - `userTtl` (string): What a person's certificate lasts. A machine and a server set up with nk sync get an hour at most.
  - `createdAt` (string): A point in time in RFC 3339 format, with up to nanosecond precision. Output uses UTC (`Z`); input may use an offset from UTC.
  - `updatedAt` (string): A point in time in RFC 3339 format, with up to nanosecond precision. Output uses UTC (`Z`); input may use an offset from UTC.
  - `sourceAddress` (string): source_address lists where people log in from. A service account has a list of its own.
  - `userPublicKeyFingerprint` (string): What ssh-keygen -lf prints for each key.
  - `hostPublicKeyFingerprint` (string)
- `user` (object)
  - `id` (string)
  - `name` (string)
  - `email` (string)
  - `picture` (string)
  - `role` (string): One of: `WORKSPACE_ROLE_UNSPECIFIED`, `WORKSPACE_ROLE_MEMBER`, `WORKSPACE_ROLE_VIEWER`, `WORKSPACE_ROLE_EDITOR`, `WORKSPACE_ROLE_ADMIN`, `WORKSPACE_ROLE_OWNER`.
  - `active` (boolean)
  - `pendingEmail` (string)
  - `createdAt` (string): A point in time in RFC 3339 format, with up to nanosecond precision. Output uses UTC (`Z`); input may use an offset from UTC.
  - `updatedAt` (string): A point in time in RFC 3339 format, with up to nanosecond precision. Output uses UTC (`Z`); input may use an offset from UTC.
  - `scimManaged` (boolean)
- `serviceAccount` (object)
  - `id` (string)
  - `name` (string)
  - `description` (string)
  - `role` (string): One of: `WORKSPACE_ROLE_UNSPECIFIED`, `WORKSPACE_ROLE_MEMBER`, `WORKSPACE_ROLE_VIEWER`, `WORKSPACE_ROLE_EDITOR`, `WORKSPACE_ROLE_ADMIN`, `WORKSPACE_ROLE_OWNER`.
  - `tags` (array<string>)
  - `lastUsedAt` (string): 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): A point in time in RFC 3339 format, with up to nanosecond precision. Output uses UTC (`Z`); input may use an offset from UTC.
  - `updatedAt` (string): A point in time in RFC 3339 format, with up to nanosecond precision. Output uses UTC (`Z`); input may use an offset from UTC.
  - `forceCommand` (string): force_command replaces what a login asks to run. source_address lists the addresses a login may come from. Both go on the account's certificates, and the CA's own settings don't.
  - `sourceAddress` (string)

```json
{
  "targets": [
    {
      "id": "string",
      "daemonId": "string",
      "name": "string",
      "description": "string",
      "hostPublicKey": "string",
      "tags": [
        "string"
      ],
      "endpoints": [
        "string"
      ],
      "usernames": [
        "string"
      ],
      "accounts": [
        {
          "id": "string",
          "targetId": "string",
          "username": "string",
          "userIds": [
            "string"
          ],
          "teamIds": [
            "string"
          ],
          "serviceAccountIds": [
            "string"
          ],
          "createdAt": "2023-01-15T01:30:15.01Z",
          "seenAt": "2023-01-15T01:30:15.01Z",
          "expiresAt": {
            "property1": "2023-01-15T01:30:15.01Z",
            "property2": "2023-01-15T01:30:15.01Z"
          }
        }
      ],
      "metadata": {
        "property1": "string",
        "property2": "string"
      },
      "createdAt": "2023-01-15T01:30:15.01Z",
      "updatedAt": "2023-01-15T01:30:15.01Z",
      "lastSyncAt": "2023-01-15T01:30:15.01Z",
      "usernameExpiresAt": {
        "property1": "2023-01-15T01:30:15.01Z",
        "property2": "2023-01-15T01:30:15.01Z"
      },
      "blocked": "ACCESS_BLOCK_UNSPECIFIED",
      "daemon": {
        "id": "string",
        "name": "string",
        "online": true,
        "status": "DAEMON_STATUS_UNSPECIFIED",
        "config": {
          "recordSessions": true,
          "allowForwarding": true,
          "allowAgentForwarding": true,
          "gatewayPorts": true,
          "ephemeral": true,
          "idleTimeout": "string"
        },
        "updatedAt": "2023-01-15T01:30:15.01Z",
        "createdAt": "2023-01-15T01:30:15.01Z",
        "lastSeenAt": "2023-01-15T01:30:15.01Z",
        "version": "string",
        "behindSince": "2023-01-15T01:30:15.01Z"
      }
    }
  ],
  "daemons": [
    {
      "id": "string",
      "name": "string",
      "online": true,
      "status": "DAEMON_STATUS_UNSPECIFIED",
      "config": {
        "recordSessions": true,
        "allowForwarding": true,
        "allowAgentForwarding": true,
        "gatewayPorts": true,
        "ephemeral": true,
        "idleTimeout": "string"
      },
      "updatedAt": "2023-01-15T01:30:15.01Z",
      "createdAt": "2023-01-15T01:30:15.01Z",
      "lastSeenAt": "2023-01-15T01:30:15.01Z",
      "version": "string",
      "behindSince": "2023-01-15T01:30:15.01Z"
    }
  ],
  "certificateAuthority": {
    "id": "string",
    "userPublicKey": "string",
    "hostPublicKey": "string",
    "rotatedAt": "2023-01-15T01:30:15.01Z",
    "userTtl": "string",
    "createdAt": "2023-01-15T01:30:15.01Z",
    "updatedAt": "2023-01-15T01:30:15.01Z",
    "sourceAddress": "string",
    "userPublicKeyFingerprint": "string",
    "hostPublicKeyFingerprint": "string"
  },
  "user": {
    "id": "string",
    "name": "string",
    "email": "string",
    "picture": "string",
    "role": "WORKSPACE_ROLE_UNSPECIFIED",
    "active": true,
    "pendingEmail": "string",
    "createdAt": "2023-01-15T01:30:15.01Z",
    "updatedAt": "2023-01-15T01:30:15.01Z",
    "scimManaged": true
  },
  "serviceAccount": {
    "id": "string",
    "name": "string",
    "description": "string",
    "role": "WORKSPACE_ROLE_UNSPECIFIED",
    "tags": [
      "string"
    ],
    "lastUsedAt": "2023-01-15T01:30:15.01Z",
    "createdAt": "2023-01-15T01:30:15.01Z",
    "updatedAt": "2023-01-15T01:30:15.01Z",
    "forceCommand": "string",
    "sourceAddress": "string"
  }
}
```

### default: Error

Returns `connect.error`.

- `code` (string): The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code]. One of: `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.

```json
{
  "code": "not_found",
  "message": "string",
  "details": [
    {
      "type": "string",
      "value": "string",
      "debug": {}
    }
  ]
}
```

## Example request

```bash
curl -X POST 'https://app.nokku.sh/nokku.v1.TargetService/GetSubjectAccess' \
  -H 'Authorization: Bearer <token>' \
  -H 'Content-Type: application/json' \
  -d '{
  "subjectId": "68460e63-0717-47f9-8fd8-d28f152cb30b"
}'
```
