# ListAccessRequests

`POST /nokku.v1.AccessRequestService/ListAccessRequests`

ListAccessRequests

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)

- `status` (string): One of: `ACCESS_REQUEST_STATUS_UNSPECIFIED`, `ACCESS_REQUEST_STATUS_PENDING`, `ACCESS_REQUEST_STATUS_APPROVED`, `ACCESS_REQUEST_STATUS_DENIED`, `ACCESS_REQUEST_STATUS_CANCELLED`, `ACCESS_REQUEST_STATUS_EXPIRED`.
- `limit` (integer)
- `offset` (integer)

Example:

```json
{
  "status": "ACCESS_REQUEST_STATUS_UNSPECIFIED",
  "limit": 1,
  "offset": 0
}
```

## Responses

### 200: Success

Returns `nokku.v1.ListAccessRequestsResponse`.

- `requests` (array<nokku.v1.AccessRequest>)
- `total` (integer)

```json
{
  "requests": [
    {
      "id": "string",
      "requesterId": "string",
      "requesterName": "string",
      "requesterEmail": "string",
      "targetId": "string",
      "targetName": "string",
      "username": "string",
      "duration": "string",
      "reason": "string",
      "status": "ACCESS_REQUEST_STATUS_UNSPECIFIED",
      "decidedBy": "string",
      "deciderName": "string",
      "decidedAt": "2023-01-15T01:30:15.01Z",
      "createdAt": "2023-01-15T01:30:15.01Z",
      "grantedUntil": "2023-01-15T01:30:15.01Z"
    }
  ],
  "total": 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.AccessRequestService/ListAccessRequests' \
  -H 'Authorization: Bearer <token>' \
  -H 'Content-Type: application/json' \
  -d '{
  "status": "ACCESS_REQUEST_STATUS_UNSPECIFIED",
  "limit": 1,
  "offset": 0
}'
```
