# PlanGrant

`POST /nokku.v1.TargetAccountService/PlanGrant`

PlanGrant says what Grant would do with the same request, and changes nothing.

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)

- `grant` (object, required): 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): Unset is for good.
  - `changeEnds` (boolean): A grant that stands with another end keeps it, unless this is set.

Example:

```json
{
  "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
  }
}
```

## Responses

### 200: Success

Returns `nokku.v1.PlanGrantResponse`.

- `plan` (object)
  - `servers` (integer): 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): 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>)

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

### 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.TargetAccountService/PlanGrant' \
  -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
  }
}'
```
